diff --git a/docs/getting-started.rst b/docs/getting-started.rst --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -12,7 +12,7 @@ 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 @@ 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 rename from docs/getting-started-index.rst rename to docs/getting-started/index.rst --- a/docs/getting-started-index.rst +++ b/docs/getting-started/index.rst @@ -2,11 +2,12 @@ =============== .. 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 --- /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 --- a/docs/index.rst +++ b/docs/index.rst @@ -186,7 +186,7 @@ :titlesonly: :hidden: - getting-started-index + getting-started/index architecture/index contributing/index tutorials/index