Commit Graph

8 Commits

Author SHA1 Message Date
Andreas Jaeger 58d1e5b3bf Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Iab15b05918b73ce9ba2ff0b479fdb8a0631fad42
2020-06-04 14:27:03 +02:00
Kristal Dale 7756b4cfb6 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:38348

Change-Id: I4840bfb9c17128e1883e36b8292ce325045b618a
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:38:20 -08:00
Kristine Bujold 4ef138fcf1 Collapse the glance filesystem into platform
The filesystem /opt/cgcs is removed and the “helm_charts” and “keystone”
folders now resides under /opt/platform.

  ls /opt/platform/
  armada  config  helm  nfv  puppet  sysinv

  ls /opt/cgcs/
  helm_charts  keystone

Resources related to cgcs-drbd and /opt/cgcs are removed from puppet.
SMS is no longer monitoring these resources.

Tested in AIO-SX, AIO-DX and Standard hardware labs.

Depends-On: https://review.opendev.org/674360
Partial-Bug: 1830142

Change-Id: I4be7a877efb89bb9e5c2b067bdc7e4259f2b0c0c
Signed-off-by: Kristine Bujold <kristine.bujold@windriver.com>
2019-08-02 13:35:54 -04:00
Kristal Dale cf8a2fffc9 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)

Story: 2004737
Task: 28801

Change-Id: I83d023c57881e03639ff6bb85b256e53f4205817
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-01-08 15:20:30 -08:00
Abraham Arce eb86e7e885 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I37051b4bd80d87a2282f5eec65e849d8ac1e77d7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:36:04 +00:00
Dean Troyer 3f59251726 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: I0791ab622ed187d8bdf93e5b848fa70a0d3e6c2c
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:16:45 -05:00
Scott Rifenbark fe6452e19e stx-ha: API ref doc content added.
I added the api-ref-smapi-v1-ha.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.

Provided info for API Details response.

Change-Id: Iae5b7297d27621b7862830e402109ecfa7faba09
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-27 17:40:43 +00:00
Abraham Arce a59b5954d1 [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: 25749

Change-Id: I54d5637c1611c824eac3f3cb45a00559f2a28ab7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-27 10:14:44 -07:00