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

26 lines
654 B
ReStructuredText
Raw Normal View History

[Doc] Installation Guide Xml Definitions Installation guides should list the XML server definitions for each configuration: - Controller-N - Compute-N - Storage-N Additionally, where it applies: - Add method to power up virtual servers. - Reword system configuration section. - Use host-if-modify syntax valid for current release. Minor changes: - Remove DRAFT from the top of Release Notes Contribute Guide. - Fix api-ref broken links Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de Signed-off-by: Kristal Dale <kristal.dale@intel.com> Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 07:28:21 -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 Reference
[Doc] Installation Guide Xml Definitions Installation guides should list the XML server definitions for each configuration: - Controller-N - Compute-N - Storage-N Additionally, where it applies: - Add method to power up virtual servers. - Reword system configuration section. - Use host-if-modify syntax valid for current release. Minor changes: - Remove DRAFT from the top of Release Notes Contribute Guide. - Fix api-ref broken links Change-Id: I2aed6a2dadd58bf5f701f15b94257afd5d79e6de Signed-off-by: Kristal Dale <kristal.dale@intel.com> Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-22 07:28:21 -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
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:
* `Bare Metal <stx-metal/index.html>`__
* `Configuration <stx-config/index.html>`__
* `Distributed Cloud <stx-distcloud/index.html>`__
* `Fault Management <stx-fault/index.html>`__
* `High Availability <stx-ha/index.html>`__
* `NFV <stx-nfv/index.html>`__
stx-update: API Ref Doc Content Enabled API Reference content has been added for stx-update: - Add link and pages for API Ref and main page. The project-specific docs are published independently so we need to maintain the links into those subtrees, for the api-ref (/api-ref/stx-*). This change was introduced and then reverted due to this abandoned commit: https://review.openstack.org/#/c/605278/ Reason was a confussion during the split of old API into the new API scheme. Depends-On: https://review.openstack.org/#/c/634994/ Change-Id: I3a4bd5e98cf7077cf4c3abe037d1a0f6d8c69fcf Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2019-02-01 04:57:21 -06:00
* `Software Updates <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
StarlingX also has API References for the modified OpenStack APIs:
[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
.. toctree::
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
:maxdepth: 1
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
api-ref-blockstorage-v2-cgcs-ext
api-ref-compute-v2-cgcs-ext
api-ref-image-v2-cgcs-ext
api-ref-networking-v2-cgcs-ext
Add api-ref publish job * Add pointers in the main doc to api-ref and releasenotes pages * Add publish-stx-api-ref job * Add search at bottom of api-ref and relnotes pages to trigger the jobs * Add openstackdocstheme installation into requirements file Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399 Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
2018-10-11 08:40:19 -05:00
:ref:`search`
Copy Permalink