Commit Graph

10 Commits

Author SHA1 Message Date
Pablo Bovina e8d00192c5 Removing system uuid from alarms summary
System UUID not required to be part of alarms summary.

This is also needed to allow non-admin users to read
alarms summary.

Story: 2009077
Task: 42995

Signed-off-by: Pablo Bovina <pablo.bovina@windriver.com>
Change-Id: I55c0cb297be7e86d31bce116e8ba20a2162d2f04
2021-08-12 19:55:39 -04:00
Andreas Jaeger f555f4a717 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: I0f1672c32d14ce7a096bf8c68741208b6fa2434c
2020-06-04 14:20:25 +02:00
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
Abraham Arce d911b3972a [Doc] API Content Gaps
As a result of time spent within stx-fault, there are API reference content
gaps:

- "The API document should be modified to match the description returned from
  API query": changed both the name of the desciption.
- "Wrong "links" reference: changed to existing StarlingX stx-fault API
  reference.
- Additional: Remove <U+200B> character.

More Information:

- [Starlingx-discuss] API requests: stx-fault [0]
- Etherpad StarlingX APIs Review [1]

[0] http://lists.starlingx.io/pipermail/starlingx-discuss/2018-December/002150.html
[1] https://etherpad.openstack.org/p/stx-apis

Story: 2004877
Task: 29153

Change-Id: Ifb3da9492b74b4ecf7be265294af5d2e604d56e5
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-01-28 09:12:32 -06:00
Kristine Bujold 80a9ad661f Enhance get list APIs for alarms and events
Include the optional “expand” option to the get list for alarms and
events so the entire set of data can be returned and not just a
subset. “expand” is and optional parameter and defaults to False.

Story: 2004818
Task: 29096

Change-Id: Ife3b900d90c56564e9aeaa820e57f69d15194eb3
Signed-off-by: Kristine Bujold <kristine.bujold@windriver.com>
2019-01-25 10:43:57 -05: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
Abraham Arce b8cdd99f46 [Doc] openstackdocstheme starlingxdocs theme
Enable starlingxdocs theme support for:

- Documentation
- Release Notes
- API Reference

Change-Id: I409c014e65472c6421ba46f610638299192cb942
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 14:35:29 +00: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
Scott Rifenbark 929a6f510c stx-fault: API ref doc content added.
I added the api-ref-fm-v1-fault.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.

Added details for "Shows details for Fault Management API v1"

Change-Id: Ie0daae5b4ddc6c6363f647b15c507b664635b2d3
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-27 09:17:21 -07:00
Abraham Arce e3d4f08eb5 [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
- Adding SPDX-License-Identifier: Apache-2.0

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

Story: 2002712
Task: 26697

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