summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKristal Dale <kristal.dale@intel.com>2018-12-27 16:53:38 -0800
committerKristal Dale <kristal.dale@intel.com>2019-01-08 15:52:04 -0800
commit6cd39f8226b84c2321d0040cd6b94f8df548485a (patch)
tree44cb6cd0bc0adf6913df509e89de012b6246af7a
parentdf76895de9a8afb9a6c7ef926fa85e7ed10e2843 (diff)
Clean up and standardize landing pages
doc index.rst: 1. Update intro sentence to read as a complete sentence 2. Remove unused toctree 3. Correct heading levels (impacting side nav and correct rendering of content) 4. Remove "Indices and Tables" section: genindex page not used, search searches only index (not useful here) api-ref index.rst: 1. Update intro sentence to read as a complete sentence 2. Update text around search link for consistency (move to follow intro) 3. Add heading before toctree for consistency with other pages release notes: 1. Standardize page title reST markup 2. Remove search (make consistent with other openstack release note pages) Story: 2004737 Task: 28803 Change-Id: I11ba3784a5d50953d62f0bc4a08f3f2b308da6b5 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Notes
Notes (review): Code-Review+1: Scott Rifenbark <srifenbark@gmail.com> Code-Review+2: Bart Wensley <barton.wensley@windriver.com> Code-Review+2: Chris Friesen <chris.friesen@windriver.com> Workflow+1: Chris Friesen <chris.friesen@windriver.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 23 Jan 2019 15:59:28 +0000 Reviewed-on: https://review.openstack.org/627580 Project: openstack/stx-distcloud Branch: refs/heads/master
-rw-r--r--api-ref/source/index.rst9
-rw-r--r--doc/source/index.rst16
-rw-r--r--releasenotes/source/index.rst3
3 files changed, 11 insertions, 17 deletions
diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
index f05e117..8bc1ee9 100644
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@@ -2,11 +2,14 @@
2stx-distcloud API Reference 2stx-distcloud API Reference
3=========================== 3===========================
4 4
5StarlingX Distributed Cloud 5Use the StarlingX stx-distcloud API to manage distributed cloud operations.
6
7stx-distcloud API content can be searched using the :ref:`search page <search>`.
8
9API Reference
10-------------
6 11
7.. toctree:: 12.. toctree::
8 :maxdepth: 2 13 :maxdepth: 2
9 14
10 api-ref-dcmanager-v1 15 api-ref-dcmanager-v1
11
12:ref:`search`
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 4d35712..81fba22 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,11 +1,9 @@
1===========================
1stx-distcloud Documentation 2stx-distcloud Documentation
2=========================== 3===========================
3 4
4StarlingX Distributed Cloud 5The StarlingX stx-distcloud project provides management for distributed
5 6cloud operations.
6.. toctree::
7 :maxdepth: 2
8 :caption: Contents:
9 7
10Release Notes 8Release Notes
11------------- 9-------------
@@ -24,7 +22,7 @@ API Reference
24 API Reference <https://docs.starlingx.io/api-ref/stx-distcloud> 22 API Reference <https://docs.starlingx.io/api-ref/stx-distcloud>
25 23
26Links 24Links
27===== 25-----
28 26
29* Source: `stx-distcloud`_ 27* Source: `stx-distcloud`_
30* Code Review: `Gerrit`_ 28* Code Review: `Gerrit`_
@@ -33,9 +31,3 @@ Links
33.. _stx-distcloud: https://git.starlingx.io/cgit/stx-distcloud/ 31.. _stx-distcloud: https://git.starlingx.io/cgit/stx-distcloud/
34.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud 32.. _Gerrit: https://review.openstack.org/#/q/project:openstack/stx-distcloud
35.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud 33.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/stx-distcloud
36
37Indices and Tables
38==================
39
40* :ref:`search`
41* :ref:`genindex`
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 858230f..dfe8303 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -1,3 +1,4 @@
1===========================
1stx-distcloud Release Notes 2stx-distcloud Release Notes
2=========================== 3===========================
3 4
@@ -5,5 +6,3 @@ stx-distcloud Release Notes
5 :maxdepth: 2 6 :maxdepth: 2
6 7
7 unreleased 8 unreleased
8
9:ref:`search`