Commit Graph

6 Commits

Author SHA1 Message Date
Kristal Dale 54ed99eb3c Update landing pages for docs, api-ref, and release notes:
- Use updated project name in titles/text
- Correct text for link to Storyboard (docs)
- Correct capitalization in section headings
- Correct formatting for section headings
- Update project name in link to release notes, api-ref
- Update project name in config for docs/releasenotes/api-ref

Story:2007193
Task:38342

Change-Id: I65d4b92deef90c09f7c1f309bf79e454c570c8a1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:36:06 -08:00
junboli d2d82d5660 Fix the error links for distcloud docs
The storyboard and gerrit doc link are error, and git library
redirect to the correct one, this change is to correct all them.

Change-Id: I58fb35cf4bd4edde173c5d7e55bc6ced1ee08d60
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 09:15:52 -04:00
Kristal Dale 6cd39f8226 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>
2019-01-08 15:52:04 -08:00
Dean Troyer f65be03019 Add api-ref and relnotes publish jobs
* Add pointers in the main doc to api-ref and releasenotes pages
* Add publish-stx-api-ref and publish-stx-releasenotes jobs
* Add search at bottom of api-ref and relnotes pages to trigger the jobs

Depends-On: https://review.openstack.org/#/c/608409/

Change-Id: Ide9a7d5829b41191c9127af75c4320f94d82f428
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 05:16:22 -05:00
Dean Troyer b698d300c1 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: I2d5d4456b3f21ea2c27f6e6b519170482f617fb5
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-11 05:16:01 -05:00
Abraham Arce e536aba329 [Doc] Building docs following Docs Contrib Guide
Baseline changes to comply with OpenStack Documentation
Contributor Guide [0] starting with the following sections:

- Project guide setup
  - [1] sphinx-quickstart
  - [2] doc/source/ layout
- Building documentation
  - [3] tox -e docs
- Using documentation tools
  - [4] openstackdocstheme
- Use build-openstack-docs-pti job template for docs

[0] https://docs.openstack.org/doc-contrib-guide
[1] http://www.sphinx-doc.org/en/master/usage/quickstart.html
[2] https://docs.openstack.org/doc-contrib-guide/project-guides.html
[3] https://docs.openstack.org/doc-contrib-guide/docs-builds.html
[4] https://docs.openstack.org/openstackdocstheme/

Story: 2002708
Task: 26618

Story: 2002813
Task: 26619

Change-Id: Id37ae25bf0e6bfef594da97d0a2f3747934316f0
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 08:16:59 -07:00