Commit Graph

7 Commits

Author SHA1 Message Date
Kristal Dale 6f0ed2e8fd 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:38337

Change-Id: I03de3548572d3b5f2f68cfa6105ed876c973b5e6
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:37:13 -08:00
junboli 866f85ebea Fix the error links for fault 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: I4b74c76007faf491d9c48a42c49702f388c87c98
Partial-Bug: #1835207
Signed-off-by: junboli <junbo85.li@gmail.com>
2019-07-03 09:20:01 -04:00
Mario Alfredo Carrillo Arevalo 0c7f8f2ce6 Add an overview about FM service
This commit documents an overview in order to give a general idea
about what is Fault Management service and what is the role in
StarlingX project.

Story: 2005863
Task: 33669

Change-Id: Id58385cabc9c656aa03132a42f39d9663a6be08e
Signed-off-by: Mario Alfredo Carrillo Arevalo <mario.alfredo.c.arevalo@intel.com>
2019-06-13 21:30:07 +00:00
Kristal Dale 932fdfbd70 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

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

Change-Id: I57d05e7a37997fa6941852d420cfed7e6c7c5ad6
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-12-27 16:59:48 -08:00
Dean Troyer 105a2ea2c5 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

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

Change-Id: I8881381821ca3497f3451c15043e1469d3366a52
Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-06 12:01:18 -05:00
Abraham Arce 352583420d [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
- Adding SPDX-License-Identifier: Apache-2.0

[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: 26693

Story: 2002813
Task: 26694

Change-Id: I603077bc75bfed4b6032c65dfb308a75cfb0aa76
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 15:54:38 -07:00