starlingx/docs
Code Issues Proposed changes
cc988e587c
docs/api-ref/source/index.rst

17 lines
566 B
ReStructuredText
Raw Normal View History

- 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:38353 Change-Id: I2364abf50b218acb8b58f83f8a09c4b553d2e469 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-21 16:26:04 -08:00
=============
StarlingX API
=============
[Doc] OpenStack API Reference Guide Staging Repos Baseline changes to comply with OpenStack API documentation from OpenStack Documentation Contributor Guide [0] for the following StarlingX staging repos: - stx-python-cinderclient - stx-nova - stx-glance - stx-neutron Changes: - [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: 26728 Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:45:10 -05:00
Add project links and pages for API Ref and Release Notes The project-specific docs are published independently so we need to maintain the links into those subtrees (/stx-*), also for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*). Also add docs env to the default list in tox.ini. Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 16:11:47 -05:00
StarlingX Project API References:
Fix the links not accessible Change-Id: I67c7a1a5e28b098891ee087d4d34dbfab70e9a83
2019-06-27 11:28:16 +08:00
* `Bare Metal <https://docs.starlingx.io/stx-metal/index.html>`__
* `Configuration <https://docs.starlingx.io/stx-config/index.html>`__
* `Distributed Cloud <https://docs.starlingx.io/stx-distcloud/index.html>`__
* `Fault Management <https://docs.starlingx.io/stx-fault/index.html>`__
* `High Availability <https://docs.starlingx.io/stx-ha/index.html>`__
* `NFV <https://docs.starlingx.io/stx-nfv/index.html>`__
* `Software Updates <https://docs.starlingx.io/stx-update/index.html>`__
Add project links and pages for API Ref and Release Notes The project-specific docs are published independently so we need to maintain the links into those subtrees (/stx-*), also for the api-ref (/api-ref/stx-*) and releasenotes (/releasenotes/stx-*). Also add docs env to the default list in tox.ini. Change-Id: If68e6c984d684af05124b3252a8ff3c4b44b6d82 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-12 16:11:47 -05:00
[Doc] OpenStack API Reference Guide Staging Repos Baseline changes to comply with OpenStack API documentation from OpenStack Documentation Contributor Guide [0] for the following StarlingX staging repos: - stx-python-cinderclient - stx-nova - stx-glance - stx-neutron Changes: - [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: 26728 Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-09-25 11:45:10 -05:00
stx-docs: API ref doc content added for remaining 4 docs. I added the api-ref-blockstorage-v2-cgcs-ext.rst, api-ref-compute-v2-cgcs-ext.rst, api-ref-image-v2-cgcs-ext.rst, and api-ref-networking-v2-cgcs-ext.rst files, which are content for the remaining 4 API reference manuals 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. Change-Id: I4c3e89d38b1e6afd52d0307fb95be8c0d974ff45 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2018-09-25 17:11:58 -07:00
Copy Permalink