starlingx/docs
Code Issues Proposed changes
0568c4cc6e
docs/doc/source/api-ref/index.rst

22 lines
692 B
ReStructuredText
Raw Normal View History

General clean up of presentation; migrate release notes from wiki - Landing page: - General clean up (org of page, improve wording, markdown clean up) - Replace Abstract with welcome text, move link to project spec to welcome. - Include ref to contribute guide in Contribute section - Remove "Contents" caption from toctree (so it wont render in side nav) - Release notes page: - Remove "StarlingX" from page title. - Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes - Improve wording, link text - API ref page: Update page title to "REST API Reference" - All pages: - Capitalization corrections - Clean up section heading markdown for consistency - libvert installation page: - corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy) Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-12 15:37:24 -08:00
==================
REST API Reference
==================
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
General clean up of presentation; migrate release notes from wiki - Landing page: - General clean up (org of page, improve wording, markdown clean up) - Replace Abstract with welcome text, move link to project spec to welcome. - Include ref to contribute guide in Contribute section - Remove "Contents" caption from toctree (so it wont render in side nav) - Release notes page: - Remove "StarlingX" from page title. - Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes - Improve wording, link text - API ref page: Update page title to "REST API Reference" - All pages: - Capitalization corrections - Clean up section heading markdown for consistency - libvert installation page: - corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy) Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-12 15:37:24 -08:00
StarlingX project REST API references:
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
* `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>`__
General clean up of presentation; migrate release notes from wiki - Landing page: - General clean up (org of page, improve wording, markdown clean up) - Replace Abstract with welcome text, move link to project spec to welcome. - Include ref to contribute guide in Contribute section - Remove "Contents" caption from toctree (so it wont render in side nav) - Release notes page: - Remove "StarlingX" from page title. - Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes - Improve wording, link text - API ref page: Update page title to "REST API Reference" - All pages: - Capitalization corrections - Clean up section heading markdown for consistency - libvert installation page: - corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy) Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-12 15:37:24 -08:00
StarlingX also has API references for the modified OpenStack APIs:
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
* `Block Storage v2 <stx-docs/api-ref-blockstorage-v2-cgcs-ext.html>`__
* `Compute v2 <stx-docs/api-ref-compute-v2-cgcs-ext.html>`__
[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
* `Image v2 <stx-docs/api-ref-image-v2-cgcs-ext.html>`__
* `Network v2 <stx-docs/api-ref-networking-v2-cgcs-ext.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
:ref:`search`
Copy Permalink