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

271 lines
4.5 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.
Bump index to r8 Update current version reference Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ibd868de76662d71c3746d97c0bde3132ffd6829d
2023-02-22 15:39:04 -05:00
**The most recent supported release is StarlingX R8.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`.
Updated the Stx Welcome Page to add Stx 7.0 Release Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com> Change-Id: I41473baa0da0b429d4a4d0eeca4e06dc5d507974
2022-09-07 12:54:42 -04:00
* Download the pre-built ISO (CentOS and Debian) and Docker images for
Change links provided in doc for users In bullet point 4 inside the Host Setup topic, the link provided to download the ISO gives the user too many options and unclear instructions on wher exactly to find the ISO file. We propose that the first link is always to the latest release and then additional versions can be found on a second link. Other references to the mirror are updated as well. Additionally, on the Introduction page (https://docs.starlingx.io/), the provided link is for release 8. We also changed it to point to the latest release. The main page still shows the current version, however now the change is pretty straighforwar for when new releases come. Closes-Bug: 2016032 Change-Id: I94201ef4f436b137f2601b033cb344d726384b55 Signed-off-by: Bruno Muniz <bruno.muniz@encora.com>
2023-04-12 15:14:41 -03:00
StarlingX latest release that are located at the ``CENGN StarlingX mirror`` repos:
Updated the Stx Welcome Page to add Stx 7.0 Release Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com> Change-Id: I41473baa0da0b429d4a4d0eeca4e06dc5d507974
2022-09-07 12:54:42 -04:00
Change links provided in doc for users In bullet point 4 inside the Host Setup topic, the link provided to download the ISO gives the user too many options and unclear instructions on wher exactly to find the ISO file. We propose that the first link is always to the latest release and then additional versions can be found on a second link. Other references to the mirror are updated as well. Additionally, on the Introduction page (https://docs.starlingx.io/), the provided link is for release 8. We also changed it to point to the latest release. The main page still shows the current version, however now the change is pretty straighforwar for when new releases come. Closes-Bug: 2016032 Change-Id: I94201ef4f436b137f2601b033cb344d726384b55 Signed-off-by: Bruno Muniz <bruno.muniz@encora.com>
2023-04-12 15:14:41 -03:00
- https://mirror.starlingx.cengn.ca/mirror/starlingx/release/latest_release/debian/monolithic/outputs/iso/
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::
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
Community contributions to the documentation are welcome! If you see an
empty 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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
------------
Introduction
------------
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
Simplify install dirs Simplify install doc dir structure - Remove r6 directory - Rename r7 directory to be non release-specific - Delete unused files - Delete obsolete include files - Delete obsolete commented sections in install topics - Remove redundent version menu entry Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I59634826d4b3af41410e9d26cc182f6b4aed8ade
2022-12-30 09:05:46 -05:00
:ref:`Virtual All-in-one Simplex Installation <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
Unique index names (intro) Make Introduction index name unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ic0cf24fa21be3f7b0f02d786ecc2f554624cb18b
2022-01-20 11:24:02 -05:00
introduction/index-intro-27197f27ad41
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-------------------------
Deployment configurations
-------------------------
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
.. toctree::
:maxdepth: 2
Unique index names (deploy) Make Deployment index names unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Iedaa580b2bf007f6041b43017b5ef469c9a13f4d
2022-01-28 07:25:43 -05:00
deploy/index-deploy-da06a98b83b1
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
--------
Planning
--------
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
Unique index names (planning) Make Planning guide index names unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ia3240ad3cb794c160de238f04fbd794512332a11
2022-01-20 12:53:05 -05:00
planning/index-planning-332af0718d15
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
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
Unique index names (install) Make install/deploy index names unique. Implemented patcheset 1 review comment. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Idec2a9f701242f33c0e84048e109c49a5adee3ad
2022-01-19 12:46:07 -05:00
deploy_install_guides/index-install-e083ca818006
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
--------
Security
--------
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
Unique index names (security) Make Security index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ia0b5f267ba7c14f5e916d0f685e252c1da1f196c
2022-01-21 08:02:07 -05:00
security/index-security-84d0d8aa401b
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
--------------------
System configuration
--------------------
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
.. toctree::
:maxdepth: 2
Unique index names (sysconf) Make System Configuration index names unique Patchset 1 review comment updates Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I24e4ded48362f28072321d432b38ce4031310f61
2022-01-21 08:48:47 -05:00
system_configuration/index-sysconf-d511820651f0
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-------------
Data networks
-------------
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
.. toctree::
:maxdepth: 2
Unique index names (datanet) Make datanet index names unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ibe427683fd12d386fb20051c58e1e9c5af6db088
2022-01-19 11:07:27 -05:00
datanet/index-datanet-e316bf6c2f6a
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
---------------
Node management
---------------
Security guide update Re-organized topic hierarchy Tiny edit to restart review workflow. Squashed with Resolved index.rst conflict commit Change-Id: I13472792cb19d1e9975ac76c6954d38054d606c5 Signed-off-by: Keane Lim <keane.lim@windriver.com> Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-08-31 11:01:56 -04:00
.. toctree::
:maxdepth: 2
Unique index names (node) Make Node Management index name unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I72a6c92690f67cd6b16ba7be78dbba11455fd907
2022-01-20 12:21:22 -05:00
node_management/index-node-mgmt-cd0f9d8eaee6
Security guide update Re-organized topic hierarchy Tiny edit to restart review workflow. Squashed with Resolved index.rst conflict commit Change-Id: I13472792cb19d1e9975ac76c6954d38054d606c5 Signed-off-by: Keane Lim <keane.lim@windriver.com> Signed-off-by: MCamp859 <maryx.camp@intel.com>
2020-08-31 11:01:56 -04:00
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-------
Storage
-------
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
.. toctree::
:maxdepth: 2
Unique index names (storage) Make Storage index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I1f59864ec4ff3a2ff7581e98dfb6560881133bb0
2022-01-21 08:22:33 -05:00
storage/index-storage-6cd708f1ada9
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
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
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
----------------
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04: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
Unique index names (FM) Make Fault Management index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I34ed8d18a0500420abd7d27b4cffbcf5500ffaac
2022-01-20 08:23:30 -05:00
fault-mgmt/index-fault-98d5f50a9b8c
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
------------------
Backup and restore
------------------
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
.. toctree::
:maxdepth: 2
Unique index names (backup) Make backup and restore index names unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ic36f5468a762573e81797157ad4c926214824838
2022-01-17 12:59:32 -05:00
backup/index-backup-1b466179efc3
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-------
Updates
-------
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
.. 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
Unique index names (updates) Make Updates and Upgrades index names unique. Patchset 1 review updates. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ie849f238478e316002773eddd542bb4178ec2b31
2022-01-21 10:55:44 -05:00
updates/index-updates-e3b970bb69ce
OpenStack VNF Integration User Tasks Completed review comments Minor abbreviation fix Moved topics into its own VNF Integration section Fixed abbreviations Re-organized Kubernetes topics Change-Id: I8940d3572b789990d3b5f2d201f8ec8a46ce2943 Signed-off-by: Keane Lim <keane.lim@windriver.com>
2021-03-18 18:08:47 -04:00
KubeVirt/CDI introduction Inital draft guide for KubeVirt introduction Conditionalize version Implement patchset 2 review changes Implement patchset 3 review changes Resolve merge conflict Implement patchset 4 review changes Story: 2010466 Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I57a16fca9b78992b249a1aa04e6b12893c94fe9f
2022-12-12 06:31:24 -05:00
--------
KubeVirt
--------
.. toctree::
:maxdepth: 2
kube-virt/index-kubevirt-f1bfd2a21152
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-----------
Admin tasks
-----------
Storage Guide update Applied review feedback. Fixed 'grey bars' formatting. Fixed gerunds and lists Added abbreviations and references Change-Id: I104d678ce3ea52bddcbc141f8aad49ea1e1971db Signed-off-by: Keane Lim <keane.lim@windriver.com>
2020-12-01 17:36:57 -05:00
.. toctree::
:maxdepth: 2
Unique index names (admintasks) Make Admin Tasks index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I9d2e8b4dd7749e0293ccc157bb3428bb76e733f4
2022-01-21 11:46:53 -05:00
admintasks/index-admintasks-768a6e9aaeff
Storage Guide update Applied review feedback. Fixed 'grey bars' formatting. Fixed gerunds and lists Added abbreviations and references Change-Id: I104d678ce3ea52bddcbc141f8aad49ea1e1971db Signed-off-by: Keane Lim <keane.lim@windriver.com>
2020-12-01 17:36:57 -05:00
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
----------
User tasks
----------
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
Unique index names (usertasks) Make User Tasks index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Iff5ef5f86a7909e44424b52c496a99a5a302b65f
2022-01-21 11:27:18 -05:00
usertasks/index-usertasks-b18b379ab832
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-----------------
Guest integration
-----------------
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
.. toctree::
:maxdepth: 2
Unique index names (Guest) Make Guest Integration index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: Ie9682b888611b1acf82ff8754a7d6547ddde3c1b
2022-01-20 09:07:24 -05:00
guest_integration/index-guest-ef8c9a20bf6c
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
Fixed figure width. Worked on the comments. Corrected broken link in index. Added container integration guide. Signed-off-by: Adil <mohamed.adilassakkali@windriver.com> Change-Id: Id9d8e1abd8f15a51d9069cf7543e1b559a118369
2021-03-24 11:45:44 -03:00
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
---------
Reference
---------
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
Fixed figure width. Worked on the comments. Corrected broken link in index. Added container integration guide. Signed-off-by: Adil <mohamed.adilassakkali@windriver.com> Change-Id: Id9d8e1abd8f15a51d9069cf7543e1b559a118369
2021-03-24 11:45:44 -03:00
.. toctree::
:maxdepth: 2
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
api-ref/index
cli_ref/index
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
Add Distributed guide Some reorganization to accomodate up/down variances. Fixed merge conflicts Incorporated patchset 7 review comments Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7356e81526a94c0249526b44ce667f789245f6e2 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-23 17:07:56 -03:00
-----------------
Distributed Cloud
-----------------
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
Add Distributed guide Some reorganization to accomodate up/down variances. Fixed merge conflicts Incorporated patchset 7 review comments Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7356e81526a94c0249526b44ce667f789245f6e2 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-23 17:07:56 -03:00
.. toctree::
:maxdepth: 2
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
Unique index names (DC) Make Distributed Cloud index names unique Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I57bcb997e40c6eb74af67938a3ec25b12703dd56
2022-01-19 13:11:07 -05:00
dist_cloud/index-dist-cloud-f5dbeb16b976
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
Add documentation of Sample applications on StarlingX - Add a new top level section for Sample Application Deployments - Add doc of FlexRAN 21.07 build, deploy and run on StarlingX Story: 2009750 Task: 44207 Signed-off-by: Litao Gao <litao.gao@windriver.com> Change-Id: I1ecfe52e8061275470674e2fc1285380b9b3c06c
2021-11-29 05:13:00 -05:00
------------------------------
Sample Application Deployments
------------------------------
.. toctree::
:maxdepth: 2
Unique index names (samples) Make Samples guide index names unique. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: If830ef7a8c96018e10b66674056500f1b464dfd9
2022-01-20 13:19:23 -05:00
sample_apps/index-sample-apps-15fce86ad4bf
Add documentation of Sample applications on StarlingX - Add a new top level section for Sample Application Deployments - Add doc of FlexRAN 21.07 build, deploy and run on StarlingX Story: 2009750 Task: 44207 Signed-off-by: Litao Gao <litao.gao@windriver.com> Change-Id: I1ecfe52e8061275470674e2fc1285380b9b3c06c
2021-11-29 05:13:00 -05:00
Add Debian stub Add stub index files. Required for DS integration. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I75389a2f12e797e4521acbfcda002303c848889a
2022-06-01 08:38:01 -04:00
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
-----------------
Deprecated guides
-----------------
The guides listed here have been replaced by new guides that provide more
details.
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
.. toctree::
Remove references to install r6 and r7 Replace pointers to copies of r6 and r7 install docs on master branch with links to content built from branches. Incorp. patchset 1 review comments. Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I94305d66d77d971cddf91e16770e0fea5b7f31a8
2022-10-18 09:08:57 -04:00
:maxdepth: 1
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
Create archive for old config guides Created archive folder and moved old config guides. Added links to replacement guides in old guides/stubs. Change-Id: I0a911497aacf9b741d41524d11262531c5c17f53 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-12-08 14:25:15 -05:00
archive/index-documentation-archive-900988dce206
.. toctree::
:maxdepth: 1
:hidden:
Upstreaming WRO Removed duplicate abbrev definitions Signed-off-by: Rafael Jardim <rafaeljordao.jardim@windriver.com> Change-Id: I7910d9f54e158250004abd7e17a4e119f8064252 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-03-18 08:11:53 -03:00
Create archive for old config guides Created archive folder and moved old config guides. Added links to replacement guides in old guides/stubs. Change-Id: I0a911497aacf9b741d41524d11262531c5c17f53 Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-12-08 14:25:15 -05:00
configuration/index
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
operations/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
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
Project Specifications <https://docs.starlingx.io/specs/>
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/
TOC reorg Implemented review comments on patchset 2 Resolved index.rst merge conflict Incorporated review comments from Greg W. Some master index.rst reorg and renaming. • Introduction • Deployment Configurations • Planning • Installation Guides • Security • System Configuration • Data Networks • Node Management • Storage • Fault Management • Backup and Restore • Administrator Tasks • User Tasks • Guest Integration • Container integration • REST API Reference • CLI Reference • Deprecated guides • Contributor guides • Release Notes • Developer Resources Signed-off-by: Ron Stone <ronald.stone@windriver.com> Change-Id: I0f37c058f219c67610decbe2e97fd412f9a55a33 Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-04-05 10:22:21 -04:00
Copy Permalink