starlingx/fault
Code Issues Proposed changes
5fbfd8b066
fault/api-ref/source/index.rst

18 lines
360 B
ReStructuredText
Raw Normal View History

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-15 15:00:08 -08:00
==============================
Fault Management API Reference
==============================
[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-24 12:16:02 -05:00
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-15 15:00:08 -08:00
Use the StarlingX Fault Management API for alarm and event collection of the
cloud platform.
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
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-15 15:00:08 -08:00
Search Fault Management API content using the :ref:`search page <search>`.
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
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-15 15:00:08 -08:00
-------------
API reference
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
-------------
[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-24 12:16:02 -05:00
.. toctree::
:maxdepth: 2
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-25 16:02:52 -07:00
api-ref-fm-v1-fault
Copy Permalink