From 030ec3592e3a16e67d100b1c89cdbf34b9daabf9 Mon Sep 17 00:00:00 2001
From: Valentin Lorentz <vlorentz@softwareheritage.org>
Date: Wed, 7 Apr 2021 13:07:31 +0200
Subject: [PATCH] Include docker/README.rst
So the docker documentation is available on docs.softwareheritage.org instead
of linking to the source on Phabricator
---
docs/getting-started.rst | 8 +++-----
.../index.rst} | 7 ++++---
docs/getting-started/using-docker.rst | 3 +++
docs/index.rst | 2 +-
4 files changed, 11 insertions(+), 9 deletions(-)
rename docs/{getting-started-index.rst => getting-started/index.rst} (54%)
create mode 100644 docs/getting-started/using-docker.rst
diff --git a/docs/getting-started.rst b/docs/getting-started.rst
index c009eb1e..1521f677 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 754ce1e6..0cfc3d52 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 00000000..06fda432
--- /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 165ac496..6e46c059 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
--
GitLab