From 160301cf31f432ad12a23db2a281bdd0f5af2e4b Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 3 Feb 2016 21:01:37 +0000 Subject: [PATCH] docs: Reconfigure page structure 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 --- docs/{installation.md => deployment.md} | 0 mkdocs.yml | 13 ++++++++----- 2 files changed, 8 insertions(+), 5 deletions(-) rename docs/{installation.md => deployment.md} (100%) diff --git a/docs/installation.md b/docs/deployment.md similarity index 100% rename from docs/installation.md rename to docs/deployment.md diff --git a/mkdocs.yml b/mkdocs.yml index fd31489d..c8d81853 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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' -- 2.47.3