juergbi commented on code in PR #2124:
URL: https://github.com/apache/buildstream/pull/2124#discussion_r3323783065
##########
doc/source/main_install.rst:
##########
@@ -284,3 +317,17 @@ You must then add ``bst`` to your plugins array in
``~/.zshrc``::
bst
...
)
+
+Container Images
+================
+
+BuildStream can run inside container tools such as Docker, Podman, and Toolbx.
+
+Prebuilt images containing `bst` are available at
+[docker.io/buildstream/buildstream] via the [buildstream-docker-images]
Review Comment:
```suggestion
`docker.io/buildstream/buildstream
<https://hub.docker.com/r/buildstream/buildstream>`_ via the
`buildstream-docker-images
<https://gitlab.com/BuildStream/buildstream-docker-images/>`_
```
##########
doc/source/main_install.rst:
##########
@@ -284,3 +317,17 @@ You must then add ``bst`` to your plugins array in
``~/.zshrc``::
bst
...
)
+
+Container Images
+================
+
+BuildStream can run inside container tools such as Docker, Podman, and Toolbx.
+
+Prebuilt images containing `bst` are available at
+[docker.io/buildstream/buildstream] via the [buildstream-docker-images]
+project. Please read that project's
+[USING.md
file](https://gitlab.com/BuildStream/buildstream-docker-images/-/blob/master/USING.md)
Review Comment:
```suggestion
`USING.md file
<https://gitlab.com/BuildStream/buildstream-docker-images/-/blob/master/USING.md>`_
```
##########
doc/source/main_install.rst:
##########
@@ -11,6 +11,39 @@
See the License for the specific language governing permissions and
limitations under the License.
+Installation
+************
+
+.. contents::
+ :depth: 2
+ :local:
+
+Installing from Packages
+=====================================
+
+.. image::
+ https://repology.org/badge/vertical-allrepos/buildstream.svg
Review Comment:
I think we should skip end-of-life distros.
```suggestion
https://repology.org/badge/vertical-allrepos/buildstream.svg?exclude_unsupported=1
```
##########
doc/source/main_install.rst:
##########
@@ -284,3 +317,17 @@ You must then add ``bst`` to your plugins array in
``~/.zshrc``::
bst
...
)
+
+Container Images
+================
+
+BuildStream can run inside container tools such as Docker, Podman, and Toolbx.
+
+Prebuilt images containing `bst` are available at
+[docker.io/buildstream/buildstream] via the [buildstream-docker-images]
+project. Please read that project's
+[USING.md
file](https://gitlab.com/BuildStream/buildstream-docker-images/-/blob/master/USING.md)
+for usage instructions.
+
+Note that the Docker `--privileged` flag is usually needed, as BuildStream runs
Review Comment:
```suggestion
Note that the Docker ``--privileged`` flag is usually needed, as BuildStream
runs
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
