]> git.ipfire.org Git - thirdparty/patchwork.git/commitdiff
docs: Reconfigure page structure
authorStephen Finucane <stephen.finucane@intel.com>
Wed, 3 Feb 2016 21:01:37 +0000 (21:01 +0000)
committerStephen Finucane <stephen.finucane@intel.com>
Fri, 5 Feb 2016 17:37:57 +0000 (17:37 +0000)
There are two distinct types of documentation available: documentation
for patchwork developers and documentation for patchwork deployers.
Rework the mkdocs configuration such that this hierarchy is
established.

As part of this change, the installation doc is renamed to deployment.
This guide should be used to install patchwork in a production
environment and not necessarily a deployment one. The existing name
was misleading so fix it.

Signed-off-by: Stephen Finucane <stephen.finucane@intel.com>
docs/deployment.md [moved from docs/installation.md with 100% similarity]
mkdocs.yml

similarity index 100%
rename from docs/installation.md
rename to docs/deployment.md
index fd31489d83c345302ee2104824be4ee332117a96..c8d81853a6b2772c6a9055c284c999892f7cab3e 100644 (file)
@@ -6,8 +6,11 @@ repo_url: git://github.com/getpatchwork/patchwork
 
 pages:
  - Home: 'index.md'
- - Installation: 'installation.md'
- - Upgrading: 'upgrading.md'
- - Development: 'development.md'
- - Contributing: 'contributing.md'
- - Release Process: 'releasing.md'
+ - Development Guide:
+   - Installation: 'development.md'
+   - Contributing: 'contributing.md'
+   - Release Process: 'releasing.md'
+ - Deployment Guide:
+   - Installation: 'deployment.md'
+   - Upgrading: 'upgrading.md'
+   - API: 'api.md'