summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKristal Dale <kristal.dale@intel.com>2018-12-28 10:15:46 -0800
committerKristal Dale <kristal.dale@intel.com>2018-12-28 10:15:46 -0800
commit1161e686ec8df2c2d6e05acfe5c369417e609d74 (patch)
tree05e56cdeda5d8e30d463941eb455fe168c39bcd0
parent632037e512d6203fa13ebacc851b775c0ee6f4b4 (diff)
Clean up and standardize landing pages
doc index.rst: 1. Correct heading levels (impacting side nav and correct rendering of content) 2. Remove "Indices and Tables" section: genindex page not used, move search link to intro sentence. spec instructions.rst: 1. Update page title to be consistent w/ incoming link text (so that link with text "How to submit a spec" goes to a page titled "Submit a Spec") 2. Add section header to first list on page Change-Id: Ic3071bcf1c8d152c68d6735f08bb97e768aa944f Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Notes
Notes (review): Code-Review+1: Scott Rifenbark <srifenbark@gmail.com> Code-Review+1: zhaixiaojun <zhaixiaojun@gohighsec.com> Code-Review+1: Bruce Jones <bruce.e.jones@intel.com> Code-Review+2: Saul Wold <sgw@linux.intel.com> Code-Review+2: Shuquan Huang <huang.shuquan@99cloud.net> Code-Review+2: Brent Rowsell <brent.rowsell@windriver.com> Code-Review+2: Ian Jolliffe <ian.jolliffe@windriver.com> Workflow+1: Ian Jolliffe <ian.jolliffe@windriver.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 11 Jan 2019 19:12:48 +0000 Reviewed-on: https://review.openstack.org/627731 Project: openstack/stx-specs Branch: refs/heads/master
-rw-r--r--doc/source/index.rst16
-rw-r--r--specs/instructions.rst7
2 files changed, 13 insertions, 10 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index a1d3d0a..069202a 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -4,10 +4,15 @@
4OpenStack StarlingX Project Plans 4OpenStack StarlingX Project Plans
5================================= 5=================================
6 6
7Learn more about StarlingX project specifications for specific relseases
8and the process to submit a specification.
9
10Specification content can be searched using the :ref:`search page <search>`.
11
7Specifications 12Specifications
8============== 13--------------
9 14
10Here you can find the specs, and spec template, for each release: 15Here you can find the specs and spec template for each release:
11 16
12.. toctree:: 17.. toctree::
13 :glob: 18 :glob:
@@ -16,7 +21,7 @@ Here you can find the specs, and spec template, for each release:
16 specs/2019.03/index 21 specs/2019.03/index
17 22
18Process 23Process
19======= 24-------
20 25
21Documentation for stx-specs process: 26Documentation for stx-specs process:
22 27
@@ -27,8 +32,3 @@ Documentation for stx-specs process:
27 32
28For more details, look at spec template for the specific release, and see the 33For more details, look at spec template for the specific release, and see the
29wiki page on Blueprints: https://wiki.openstack.org/wiki/Blueprints 34wiki page on Blueprints: https://wiki.openstack.org/wiki/Blueprints
30
31Indices and tables
32==================
33
34* :ref:`search`
diff --git a/specs/instructions.rst b/specs/instructions.rst
index c02ffb5..186a11c 100644
--- a/specs/instructions.rst
+++ b/specs/instructions.rst
@@ -10,9 +10,12 @@
10 10
11.. _instructions: 11.. _instructions:
12 12
13============ 13=============
14Submit a Spec
15=============
16
14Instructions 17Instructions
15============ 18------------
16 19
17- Use STX_Example_Spec.rst under the ``approved`` subfolder of the applicable 20- Use STX_Example_Spec.rst under the ``approved`` subfolder of the applicable
18 release as the basis of your specification. 21 release as the basis of your specification.