diff --git a/docs/getting-started.rst b/docs/getting-started.rst index c009eb1e97a99d06b54bc4d155e358ad4c4dbfc8..1521f677121b951c5a39e315321291c09d4179c6 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -12,7 +12,7 @@ steps detailed below. Using Docker -++++++++++++ +------------ The easiest way to run a Software Heritage instance is to use Docker and docker-compose. Please refer to the `docker-compose documentation @@ -45,15 +45,13 @@ Code Now' feature of the archive web interface: http://localhost:5080/browse/origin/save/ For details and an overview of what you can do with your Software Heritage, -see `docker/README.md`_ +see the full :ref:`docker-environment` documentation. Enjoy filling your hard drives! -.. _docker/README.md: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/ - Hacking the archive -+++++++++++++++++++ +------------------- If you want to hack the code of the Software Heritage Archive, a bit more work will be required. diff --git a/docs/getting-started-index.rst b/docs/getting-started/index.rst similarity index 54% rename from docs/getting-started-index.rst rename to docs/getting-started/index.rst index 754ce1e610f0c56478f1117d2e7d956b0fe4854a..0cfc3d5225bc19608940e0633da3f3fc77b22639 100644 --- a/docs/getting-started-index.rst +++ b/docs/getting-started/index.rst @@ -2,11 +2,12 @@ Getting started =============== .. this index file is used to force a hierarchy in the toctree, - even though these two files are in the same directory + even though these two files are in the parent directory .. toctree:: :maxdepth: 2 :titlesonly: - getting-started - developer-setup + ../getting-started + ../developer-setup + using-docker diff --git a/docs/getting-started/using-docker.rst b/docs/getting-started/using-docker.rst new file mode 100644 index 0000000000000000000000000000000000000000..06fda43245cd2d4e42625ad32f58dc09275ca5c8 --- /dev/null +++ b/docs/getting-started/using-docker.rst @@ -0,0 +1,3 @@ +.. _docker-environment: + +.. include:: ../../../docker/README.rst diff --git a/docs/index.rst b/docs/index.rst index 165ac496f4b2a34f1961c8f58d85ed675e2516cd..6e46c05964c4ec44712a05a1af2bc8c7db2de6ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -186,7 +186,7 @@ Indices and tables :titlesonly: :hidden: - getting-started-index + getting-started/index architecture/index contributing/index tutorials/index