6 Commits

Author SHA1 Message Date
Kristal Dale
53914fc55c Update landing pages for docs 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:38350

Change-Id: I3c44012bc67136aed1e12c63037c822db7cdc4a6
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:38:46 -08:00
junboli
d5059cc9ff Fix the error links for integ 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: Ife79a7b697d562fac0f09163c036c4216a14f63d
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 09:17:48 -04:00
Kristal Dale
95d66cbd26 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)

releasenotes index.rst:
1. Standardize page title reST markup
2. Remove search (make consistent with other openstack release note pages)

Change-Id: I42e5b160336baf8498a83a5414a6e353cc529c5c
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 17:06:20 -08:00
Dean Troyer
c7dfc772fa Add relnotes publish job
* Add pointers in the main doc to releasenotes pages
* Add publish-stx-releasenotes job
* Add search at bottom of relnotes page to trigger the job

Change-Id: I3ba4672681bdcc1810e10c534cfa0e49b4d82a2c
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 15:07:01 -05:00
Dean Troyer
35813762a7 Add publish job for docs
Also set the theme to alabaster until starlingxdocs is ready

Change-Id: Idcfe4244f6d43380c8cee87d165ca2786f3e1767
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 14:19:53 -05:00
Abraham Arce
f00b501641 [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: 26718

Story: 2002813
Task: 24450

Change-Id: Id66fed45d16cdcad13988cd04f9c783398bfa781
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 04:30:20 -05:00