You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@buildstream.apache.org by "joshua-zivkovic (via GitHub)" <gi...@apache.org> on 2026/05/20 10:38:47 UTC
[PR] WIP: Add install docs from buildstream-site [buildstream]
joshua-zivkovic opened a new pull request, #2124:
URL: https://github.com/apache/buildstream/pull/2124
As addressed on the mailing list, port installation docs to the main buildstream docs.
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add install docs from buildstream-site [buildstream]
Posted by "juergbi (via GitHub)" <gi...@apache.org>.
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add install docs from buildstream-site [buildstream]
Posted by "joshua-zivkovic (via GitHub)" <gi...@apache.org>.
joshua-zivkovic commented on code in PR #2124:
URL: https://github.com/apache/buildstream/pull/2124#discussion_r3324269597
##########
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:
Not sure how I missed all these in the last paragraph but I've fixed them all
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add install docs from buildstream-site [buildstream]
Posted by "juergbi (via GitHub)" <gi...@apache.org>.
juergbi merged PR #2124:
URL: https://github.com/apache/buildstream/pull/2124
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add install docs from buildstream-site [buildstream]
Posted by "joshua-zivkovic (via GitHub)" <gi...@apache.org>.
joshua-zivkovic commented on code in PR #2124:
URL: https://github.com/apache/buildstream/pull/2124#discussion_r3324264738
##########
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 was considering something like this, I'm happy to go with this
--
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: commits-unsubscribe@buildstream.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org