starlingx/docs
Code Issues Proposed changes
cbb1aaca3c
docs/doc/source/index.rst

185 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Initial commit for guide reorg - upcoming release - Migrated reorged content from wiki - Naming, title, and capitalization consistency, minor rewording in sections - Set up includes to reuse common content across pages - Introduction: remove 'openstack users' and 'kubernetes users' - Consolidate term definition into Key concepts page - Archive R1, move R2 to current releast, set up for R3 - Remove stub pages for duplicate content, or content deferred to R3 - Rework intro and contribute pages for better readability - Split Key concepts into two pages: Terms and Deployment Options - Pass for grammar, punctuation, licensing, etc. - Pull streamlined intro content into R2 install guides (from prev version) - Added R2 release note page - Update links to projects/project names to remove the "stx-" - Add instructions for creating a bootable USB Story: 2006315 Task: 36046 Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-21 11:27:07 -07:00
======================================
Welcome to the StarlingX Documentation
======================================
Create initial template for documentation [dtroyer: fixed linters job and added to gate queue so this can be merged] Story: 2002813 Task: 22727 Change-Id: I8a988cc49440b21176dc95bd12ad383836148dca Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
2018-07-03 18:07:53 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
StarlingX is a fully integrated edge cloud software stack that provides
everything needed to deploy an edge cloud on one, two, or up to 100 servers.
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
**The most recent supported release of StarlingX is StarlingX R4.0.**
Add link to CENGN mirror Add link to CENGN mirror on home page, introduction, and consuming doc. This review supercedes review #617965 Change-Id: I1211e26e523ce75c954c8c7f5835c2228fc94baf Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2020-01-14 16:19:38 -08:00
* See the :ref:`release-notes`.
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
* Download the `R4.0 StarlingX ISO image
StarlingX 4.0 download link change Update ISO path on main index and Release Notes Closes-Bug: 1892059 Change-Id: I6427979295ef151670687f828d22dae53b0accff Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-08-19 17:24:18 -04:00
<http://mirror.starlingx.cengn.ca/mirror/starlingx/release/4.0.1/centos/flock/outputs/>`_
from the CENGN StarlingX mirror.
Create initial template for documentation [dtroyer: fixed linters job and added to gate queue so this can be merged] Story: 2002813 Task: 22727 Change-Id: I8a988cc49440b21176dc95bd12ad383836148dca Signed-off-by: Erich Cordoba <erich.cordoba.malibran@intel.com>
2018-07-03 18:07:53 -05:00
Initial commit for guide reorg - upcoming release - Migrated reorged content from wiki - Naming, title, and capitalization consistency, minor rewording in sections - Set up includes to reuse common content across pages - Introduction: remove 'openstack users' and 'kubernetes users' - Consolidate term definition into Key concepts page - Archive R1, move R2 to current releast, set up for R3 - Remove stub pages for duplicate content, or content deferred to R3 - Rework intro and contribute pages for better readability - Split Key concepts into two pages: Terms and Deployment Options - Pass for grammar, punctuation, licensing, etc. - Pull streamlined intro content into R2 install guides (from prev version) - Added R2 release note page - Update links to projects/project names to remove the "stx-" - Add instructions for creating a bootable USB Story: 2006315 Task: 36046 Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-21 11:27:07 -07:00
For more information about the StarlingX project, refer to the
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.
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
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
.. Note::
Community contributions to the documentation are welcome! If you see an empty
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
topic and want to contribute, refer to the linked story in the topic for
details.
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
See our :doc:`Contributor guide </contributor/index>` for more information.
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
-----------
Get started
-----------
Initial commit for guide reorg - upcoming release - Migrated reorged content from wiki - Naming, title, and capitalization consistency, minor rewording in sections - Set up includes to reuse common content across pages - Introduction: remove 'openstack users' and 'kubernetes users' - Consolidate term definition into Key concepts page - Archive R1, move R2 to current releast, set up for R3 - Remove stub pages for duplicate content, or content deferred to R3 - Rework intro and contribute pages for better readability - Split Key concepts into two pages: Terms and Deployment Options - Pass for grammar, punctuation, licensing, etc. - Pull streamlined intro content into R2 install guides (from prev version) - Added R2 release note page - Update links to projects/project names to remove the "stx-" - Add instructions for creating a bootable USB Story: 2006315 Task: 36046 Change-Id: I38656fd382d1d9cf2969812c548fb7b2dc9dd31e Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-08-21 11:27:07 -07:00
Docs update for R3 - Update landing page for R3 release - Update Install guides landing page (all) for R3 - Update R3 install guides landing for release Patchset 2: Link to AIO-simplex R3 from Get Started section on landing page Change-Id: I149865531bd7f1e4cf408fb452241f9e97359597 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 13:58:33 -08:00
To get started fast with StarlingX, try the
R4 updates to landing page and install guides Updated main docs landing page with R4 links Updated Installation index page: promote R4 to supported, archive R3, and added R5 (latest) folder. Depends-On: https://review.opendev.org/742989 Change-Id: Ie8b918c2537def374de5cf6aeb0105e595ef5978 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-07-30 17:30:41 -04:00
:doc:`Virtual All-in-one Simplex installation
</deploy_install_guides/r4_release/virtual/aio_simplex>`, which requires a
minimum of hardware and configuration.
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
Learn more about StarlingX:
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
.. toctree::
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
:maxdepth: 2
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
stx-docs refactoring for new doc structure Changes included updating the StarlingX docs landing page to conform to a new list of available documents as follows: * StarlingX Introduction * Deployment Guides * Installation Guides * Developer resources * Operation Guides * Project Specifications * REST API Reference * Release Notes * Contribute So-called "dead-end" links have an explanation of content coming. Any destination associated with an existing story ID have the link to the story for reference. The existence of a "current" and "latest" Developer Guides resulted in the top-level list of doc resources including both the "Developer Guides" and "Developer Resources" bullets. Ideally, the Developer Guides would be included as part of the "Developer Resources" area. For "latest" they are. However, for "current" I left them alone since the 2018.10 release is out there. This organization can settle out as more releases launch. Finally, I did not focus on the writing aspect for this PR. That part can be cleaned up going forward. Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-03-28 09:38:07 -07:00
introduction/index
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
Planning guide Incorporated minor comments on patchset 2. Incorporated comments on patchset 1. Stripped trailing white spaces. Initial review submission of Planning guide (Kubernetes) Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I1f5fc7a7747098090a4ac7fd84558c27c959804f Signed-off-by: Stone <ronald.stone@windriver.com>
2020-12-29 14:48:47 -05:00
--------
Planning
--------
.. toctree::
:maxdepth: 2
planning/index
-----------------
Deployment guides
-----------------
Deployment Configuration Address review comments from previous patch. Also implemented abbreviations as substitutions in docs/doc/source/shared/strings.txt. NB: This doc still to be reconciled against existing install/deploy content. Restored fault/index version of FM toctree in top-level index. Removed Fault Management from top-level index. Initial review submission. Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I76c2e99bd96bb1d58d6daf67ac46e6e48e4396d7 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-27 14:26:36 -05:00
.. toctree::
:maxdepth: 2
deploy/index
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
-------------------
Installation guides
-------------------
.. toctree::
:maxdepth: 2
Reorg of docs master TOC * Amended to make punctuation consistent. I have re-organized the main TOC so that the new combined install/deploy manuals comes after the StarlingX introduction. I have hidden (for now) the older install and deploy manuals. Finally, I have updated the landing pages for the install/ deploy guides and the operation guides to an agreed upon format that separates out latest, upcoming, and archived releases. Change-Id: Ia18f0438152d6cb1fa7ae3e9712eb3df8f5a2862 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-07-09 12:42:16 -07:00
deploy_install_guides/index
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
-------------
Configuration
-------------
.. toctree::
:maxdepth: 2
Add nav sections/folders for config guides and admin guides - New nav section: Configuration, topic specific config guides - New nav section: Operation Guides, task specific guides - New nav item: CLI Reference - Sections organized by general, kubernetes, openstack - Stubb pages added for all top level topics in sections, with link to associated StoryBoard story Change-Id: I59f58adbb27bf4d65755cddc40a8ec565fb949f1 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-11-08 16:26:56 -08:00
configuration/index
Reorg of docs master TOC * Amended to make punctuation consistent. I have re-organized the main TOC so that the new combined install/deploy manuals comes after the StarlingX introduction. I have hidden (for now) the older install and deploy manuals. Finally, I have updated the landing pages for the install/ deploy guides and the operation guides to an agreed upon format that separates out latest, upcoming, and archived releases. Change-Id: Ia18f0438152d6cb1fa7ae3e9712eb3df8f5a2862 Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-07-09 12:42:16 -07:00
Data Networks guide Applied M. Camp's comments on patchset 4. Also, some additional formatting changes such as tidying line ends <= 79 characters, reformatting very wide ascii table as list table to control line widths, etc. Resolved conflict in _includes/data-networks-overview.rest Change-Id: I8a2a80f21d3630849900e85dc2495da1668648af Signed-off-by: Ron Stone <ronald.stone@windriver.com> Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-23 10:57:52 -04:00
------------------------------------------------
Data Network Configuration and Management Guides
------------------------------------------------
.. toctree::
:maxdepth: 2
Node Management updates Applied patchset 6 review comments Resolved merge conflicts Incorporated Greg W. patchset 4 comments. Restructured to flatten node index and folder structure Moved images to common directory Added abbreviation substittions througout Formatting fixes and stripped trailing EOL whitespaces New :abbr: substitutions in shared/strings Incorporated patch 1 changes from Greg W. and Mary C. based on review comments manually added by Mary after corrupted amend. Change-Id: Id350681c86bb85d6abf590cd7b577d2ef838eed6 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-16 14:14:57 -04:00
Edit main index file to remove dupe links Edited top-level index file and removed duplicated links for Data Networks guide. Change-Id: I85d61f566311bd2f9ead13a93103f20c4f357fe4 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-11-30 13:53:01 -05:00
datanet/index
Data Networks guide Applied M. Camp's comments on patchset 4. Also, some additional formatting changes such as tidying line ends <= 79 characters, reformatting very wide ascii table as list table to control line widths, etc. Resolved conflict in _includes/data-networks-overview.rest Change-Id: I8a2a80f21d3630849900e85dc2495da1668648af Signed-off-by: Ron Stone <ronald.stone@windriver.com> Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-23 10:57:52 -04:00
Node Management updates Applied patchset 6 review comments Resolved merge conflicts Incorporated Greg W. patchset 4 comments. Restructured to flatten node index and folder structure Moved images to common directory Added abbreviation substittions througout Formatting fixes and stripped trailing EOL whitespaces New :abbr: substitutions in shared/strings Incorporated patch 1 changes from Greg W. and Mary C. based on review comments manually added by Mary after corrupted amend. Change-Id: Id350681c86bb85d6abf590cd7b577d2ef838eed6 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-16 14:14:57 -04:00
---------------
Node Management
---------------
.. toctree::
:maxdepth: 2
node_management/index
Adding System Config Guide Incorporated patchset 8 review comments from Mary C. Conditionalized vendor-specific terms and converted code-block to parsed-literal as required Reformatted bulleted lists to definition lists Implemented abbreviation substitutions Deleted duplicate content Some minor edits for clarity Merged new abbreviation definitions in strings.txt Responding to Patch 5 comments. Change-Id: If6dd7c4cb802036445cb65853d8de7652df351c0 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-16 14:14:57 -04:00
--------------------
System Configuration
--------------------
.. toctree::
:maxdepth: 2
system_configuration/index
Fault Management guide Removed OSX and MS Visual Code metadata files and directories. Change-Id: I4e6024767cc072fcb3fc8d88f0724f02819cebc8 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-29 11:46:58 -04:00
----------------
Deployment Configuration Address review comments from previous patch. Also implemented abbreviations as substitutions in docs/doc/source/shared/strings.txt. NB: This doc still to be reconciled against existing install/deploy content. Restored fault/index version of FM toctree in top-level index. Removed Fault Management from top-level index. Initial review submission. Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I76c2e99bd96bb1d58d6daf67ac46e6e48e4396d7 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-27 14:26:36 -05:00
Fault Management
Fault Management guide Removed OSX and MS Visual Code metadata files and directories. Change-Id: I4e6024767cc072fcb3fc8d88f0724f02819cebc8 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-29 11:46:58 -04:00
----------------
.. toctree::
:maxdepth: 2
Fault Management doc Added Data Networks toctree Changed case on doc title in top level index - changed doc directory to fault-mgmt. Added Distributed Cloud section. Broke out "OpenStack Fault Management Overview" statement about remote log collection to conditionally included file. Incorporated patch 6 review comments. Also implemented rST :abbr: for first instance of SNMP in each file. Changed port number and community string in two SNMP walk examples. Change-Id: I1afd71265e752c4c9a54bf2dc9a173b3e17332a7 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-11 09:02:55 -05:00
fault-mgmt/index
Updated Patch Set 5 to include review comments Changed name of file to: admin-application-commands-and-helm-overrides.rst Updated Strings.txt Updated formatting issues: installing-and-running-cpu-manager-for-kubernetes.rst Updated Patch Set 4 to include review comments Admin Tasks Updated Changed name of include file to: isolating-cpu-cores-to-enhance-application-performance.rest Change-Id: I0b354dda3c7f66da3a5d430839b5007a6a19cfad Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com> Signed-off-by: Stone <ronald.stone@windriver.com> Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
2020-12-07 16:10:59 -05:00
-----------
Admin Tasks
-----------
.. toctree::
:maxdepth: 2
admintasks/index
User Tasks guide Fixed typo in LetsEncrypt example Removed duplicate Datanet entry from main index.rst Reworked Use Kubernetes CPU Manager Static Policy prerequisite block. Restored fault/index version of FM toctree in top-level index. Added merged doc entries to top level index.rst. Incorporated review comments. Also some generic formatting clean-up such as converting abbreviations to rST-style :abbr: markup. Moved url with embedded substitution out of code-block. Addressed patch 2 review comments. Some addtional rST tidying. See comment replies for open questions/issues. This patch fixes an issue with 'stx' in filenames that may differ downstream using-an-image-from-the-local-docker-registry-in-a-container-spec new substitution and changing code-blocks to parsed-literals as required. Initial submission for review. Note that a couple of references to WR persist in examples. These will be marked up with comments in the review. Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I1efef569842caff5def9dc00395b594d91d7a5d0 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-24 09:28:16 -05:00
----------
User Tasks
----------
.. toctree::
:maxdepth: 2
Adding System Config Guide Incorporated patchset 8 review comments from Mary C. Conditionalized vendor-specific terms and converted code-block to parsed-literal as required Reformatted bulleted lists to definition lists Implemented abbreviation substitutions Deleted duplicate content Some minor edits for clarity Merged new abbreviation definitions in strings.txt Responding to Patch 5 comments. Change-Id: If6dd7c4cb802036445cb65853d8de7652df351c0 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-16 14:14:57 -04:00
User Tasks guide Fixed typo in LetsEncrypt example Removed duplicate Datanet entry from main index.rst Reworked Use Kubernetes CPU Manager Static Policy prerequisite block. Restored fault/index version of FM toctree in top-level index. Added merged doc entries to top level index.rst. Incorporated review comments. Also some generic formatting clean-up such as converting abbreviations to rST-style :abbr: markup. Moved url with embedded substitution out of code-block. Addressed patch 2 review comments. Some addtional rST tidying. See comment replies for open questions/issues. This patch fixes an issue with 'stx' in filenames that may differ downstream using-an-image-from-the-local-docker-registry-in-a-container-spec new substitution and changing code-blocks to parsed-literals as required. Initial submission for review. Note that a couple of references to WR persist in examples. These will be marked up with comments in the review. Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I1efef569842caff5def9dc00395b594d91d7a5d0 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-11-24 09:28:16 -05:00
usertasks/index
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
----------------
Operation guides
----------------
Add docs build jobs Start with building Sphinx, include links to the anticipated locations for /releasenotes and /specs. Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-08-31 12:15:48 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
.. toctree::
:maxdepth: 2
Add docs build jobs Start with building Sphinx, include links to the anticipated locations for /releasenotes and /specs. Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-08-31 12:15:48 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
operations/index
Add docs build jobs Start with building Sphinx, include links to the anticipated locations for /releasenotes and /specs. Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-08-31 12:15:48 -05:00
Backup and Restore Patch 2 review edits. Stripped spaces at EOLs. Deleted vscode hidden directory. Initial review and resolved supporting additions to source/shared/strings.txt Signed-off-by: Stone <ronald.stone@windriver.com> Change-Id: I21895e0f451d1a11b8f9813034c31a049d4f9ad8 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-12-04 11:59:12 -05:00
------------------
Backup and restore
------------------
.. toctree::
:maxdepth: 2
backup/index
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
---------
Reference
---------
Add docs build jobs Start with building Sphinx, include links to the anticipated locations for /releasenotes and /specs. Change-Id: I111e4dfc2a31a97b869df25e0d059b8423d25d6a Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-08-31 12:15:48 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
.. toctree::
:maxdepth: 2
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
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
api-ref/index
cli_ref/index
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
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
-------------------
General information
-------------------
Add the publish job We have the AFS volume and now a publish job, let's see if we can get from here to there. Include a docs change to ensure the jobs actually run. the web server is near, pending certificate installation. Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-02 13:33:26 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
.. toctree::
:maxdepth: 1
Add the publish job We have the AFS volume and now a publish job, let's see if we can get from here to there. Include a docs change to ensure the jobs actually run. the web server is near, pending certificate installation. Change-Id: I325e97f0500e66b57b7d1cd2d2e81bee79c67f30 Signed-off-by: Dean Troyer <dtroyer@gmail.com>
2018-10-02 13:33:26 -05:00
Update landing page - Add Get Started section to landing page - Replace Contribute section with note welcoming contributions (with links) - Split Documentation section into Installation Guides, Config, Operation Guides Reference, General info sections (Improve scanability of topics) - Move note re using OpenStack CI/CD and repo link to Contribute page. - Replace link to spec with link to wiki (more relevant to new users) - Move projects section/list to StarlingX Introduction. Change-Id: Idb26869989de8b3a7a7dda0c9171e5c45e051fa0 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-12-06 15:44:38 -08:00
contributor/index
releasenotes/index
developer_resources/index
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
Add governance link Added section and paragraph to index page that provides information about and links to StarlingX governance. Change-Id: I2a993211f4cbba6a5f5d31bdec268f86e5c7e3ee Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-29 12:48:01 -07:00
----------
Governance
----------
Fault Management guide Removed OSX and MS Visual Code metadata files and directories. Change-Id: I4e6024767cc072fcb3fc8d88f0724f02819cebc8 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-29 11:46:58 -04:00
StarlingX is a top-level OpenStack Foundation pilot project that is governed by
two separate bodies: The `OpenStack Foundation Board of Directors`_ and the
`StarlingX Technical Steering Committee`_.
Add governance link Added section and paragraph to index page that provides information about and links to StarlingX governance. Change-Id: I2a993211f4cbba6a5f5d31bdec268f86e5c7e3ee Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-29 12:48:01 -07:00
See `StarlingX Governance`_ for additional information about StarlingX project
governance.
Fault Management guide Removed OSX and MS Visual Code metadata files and directories. Change-Id: I4e6024767cc072fcb3fc8d88f0724f02819cebc8 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-29 11:46:58 -04:00
.. _`OpenStack Foundation Board of Directors`: https://wiki.openstack.org/wiki/Governance/Foundation
Add governance link Added section and paragraph to index page that provides information about and links to StarlingX governance. Change-Id: I2a993211f4cbba6a5f5d31bdec268f86e5c7e3ee Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-10-29 12:48:01 -07:00
.. _`StarlingX Technical Steering Committee`: https://docs.starlingx.io/governance/reference/tsc/
Adding System Config Guide Incorporated patchset 8 review comments from Mary C. Conditionalized vendor-specific terms and converted code-block to parsed-literal as required Reformatted bulleted lists to definition lists Implemented abbreviation substitutions Deleted duplicate content Some minor edits for clarity Merged new abbreviation definitions in strings.txt Responding to Patch 5 comments. Change-Id: If6dd7c4cb802036445cb65853d8de7652df351c0 Signed-off-by: Stone <ronald.stone@windriver.com>
2020-10-16 14:14:57 -04:00
.. _`StarlingX Governance`: https://docs.starlingx.io/governance/
Copy Permalink