diff options
| author | James Ennis <james.ennis@codethink.com> | 2018-04-16 17:37:53 +0100 |
|---|---|---|
| committer | James Ennis <james.ennis@codethink.com> | 2018-04-17 16:55:47 +0100 |
| commit | 011b414a91eb11270c9e7f89056ccc69bde428db (patch) | |
| tree | 952eff0b3edfb34fa92f981fc470b98e9c36f82c | |
| parent | 51717bcc99a1497add201674571b4503cad2d1eb (diff) | |
| download | buildstream-011b414a91eb11270c9e7f89056ccc69bde428db.tar.gz | |
main_install.rst: New file with install, docker and artifacts
We now have a main installing page with three sections:
1. How to install buildstream onto your machine.
2. How to run buildstream inside docker image.
3. How to install an artifact server
| -rw-r--r-- | doc/source/artifacts.rst | 6 | ||||
| -rw-r--r-- | doc/source/docker.rst | 5 | ||||
| -rw-r--r-- | doc/source/index.rst | 3 | ||||
| -rw-r--r-- | doc/source/install.rst | 6 | ||||
| -rw-r--r-- | doc/source/main_install.rst | 15 |
5 files changed, 24 insertions, 11 deletions
diff --git a/doc/source/artifacts.rst b/doc/source/artifacts.rst index d0ff9fbab..b5003d940 100644 --- a/doc/source/artifacts.rst +++ b/doc/source/artifacts.rst @@ -2,8 +2,8 @@ .. _artifacts: -Artifact Caches -=============== +Installing an artifact server +============================= BuildStream caches the results of builds in a local artifact cache, and will avoid building an element if there is a suitable build already present in the local artifact cache. @@ -67,7 +67,7 @@ Installing the receiver ~~~~~~~~~~~~~~~~~~~~~~~ You will also need to install BuildStream on the artifact server in order to receive uploaded artifacts over ssh. Follow the instructions for installing -BuildStream :ref:`here <installing>` +BuildStream :ref:`here <install>` When installing BuildStream on the artifact server, it must be installed in a system wide location, with ``pip3 install .`` in the BuildStream diff --git a/doc/source/docker.rst b/doc/source/docker.rst index 5c7a0d21e..9b0f8aa73 100644 --- a/doc/source/docker.rst +++ b/doc/source/docker.rst @@ -1,8 +1,11 @@ + .. _docker: BuildStream inside Docker -========================= +------------------------- +If your system cannot provide the base system requirements for BuildStream, then it is possible to run buildstream within a Docker image. + The BuildStream project provides `Docker images <https://hub.docker.com/r/buildstream/buildstream-fedora>`_ containing BuildStream and its dependencies. diff --git a/doc/source/index.rst b/doc/source/index.rst index 274548b95..a4b827d48 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,8 +20,7 @@ dependencies. .. toctree:: :maxdepth: 2 - install - docker + main_install .. toctree:: diff --git a/doc/source/install.rst b/doc/source/install.rst index 6623c9100..2b844ea43 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -1,6 +1,6 @@ -.. _installing: +.. _install: Installing BuildStream ====================== @@ -13,10 +13,6 @@ BuildStream requires the following base system requirements: * PyGObject introspection bindings * psutil python library (so you don't have to install GCC and python-devel to build it yourself) -If your system cannot provide the base system requirements for BuildStream, -then we have some instructions which can help you get started -:ref:`using BuildStream with Docker <docker>`. - Installing from source (recommended) ------------------------------------ diff --git a/doc/source/main_install.rst b/doc/source/main_install.rst new file mode 100644 index 000000000..240157e00 --- /dev/null +++ b/doc/source/main_install.rst @@ -0,0 +1,15 @@ + + +.. _main_install: + +Installing +========== +This section covers how to install BuildStream onto your machine, how to run BuildStream inside a docker image and also how to configure an artifact server. + + +.. toctree:: + :maxdepth: 2 + + install + docker + artifacts |