From 5f2eb6dade5f3b19b8905b97d8e4018b5e068321 Mon Sep 17 00:00:00 2001 From: James Polley Date: Mon, 30 Mar 2015 17:36:26 +1100 Subject: [PATCH] Add a target for, and link to, minimal config docs Reading through the docs for the first time, the reader encounters an instruction to provide a minimal configuration, with a link that they'd expect to tell them how to do this. At present the link actually takes them to the top of configuration.html, where they read some history about how devstack's configuration has changed over time. This is interesting and important and should be in the docs - but in my opinion a link about setting up a minimal configuration would be more useful if it takes me to a place that tells them about a minimal configuration. To get this, I've had to an an explicit link target into configuration.rst. I'm not hugely keen on this approach, as I don't think it scales well. I'd be open to suggestions about other approaches. The only idea I've had so far though is to simply move the minimal configuration section right to the top of the page, so that a link to the doc is a link to the minimal config - the historical information could be moved to its own topic somewhere further down the doc. Change-Id: I231ca1b7f17b55f09a4e058dab8ee433893f737e --- doc/source/configuration.rst | 2 ++ doc/source/index.rst | 3 +-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index a0d0840263..1cc7083bb4 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -95,6 +95,8 @@ Also note that the ``localrc`` section is sourced as a shell script fragment and MUST conform to the shell requirements, specifically no whitespace around ``=`` (equals). +.. _minimal-configuration: + Minimal Configuration ===================== diff --git a/doc/source/index.rst b/doc/source/index.rst index c31287cd57..4435b495ae 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -41,8 +41,7 @@ Quick Start #. Configure - We recommend at least a :doc:`minimal - configuration ` be set up. + We recommend at least a :ref:`minimal-configuration` be set up. #. Start the install