Commit Graph

5 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
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
Scott Rifenbark 7d6d1ade04 stx-distcloud: API ref doc content added.
I added the api-ref-dcmanager-v1.rst file, which is content
for the API reference manual to the api-ref/source dir.
This represents the converted old-style files to the newer
OpenStack supported RST files.

I updated the index.rst file to include the new .rst file
so that the api-ref document can build.

Ran it through Gedit with the trailsaver plug-in to remove
trailing whitespace.

Change-Id: I76f6ee2658efced7038e0e5b659902382fd72284
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-25 19:57:55 +00:00
Abraham Arce 0c19a79fbd [Doc] OpenStack API Reference Guide
Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0]:

- [1] How to document your OpenStack API service

[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html

Story: 2002712
Task: 26621

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