This change addresses a long-standing issue in rST documentation imported from XML.
That import process added backslash escapes in front of various characters. The three
most common being '(', ')', and '_'.
These instances are removed.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id43a9337ffcd505ccbdf072d7b29afdb5d2c997e
Updated Patchset 5 comments (typos, removal of Limitation)
Removed "Control Group parameter" from the Deprecated list
Added note about Armada Deprecation
Updated inputs from Patchset 4.
Updated the Index file with the Release date 2023-02
Updated Patchset 2 inputs
Updated inputs from Patchset 1
Updated Comments received in https://review.opendev.org/c/starlingx/docs/+/862596/6
Added Stx 8.0 Features in the Introduction Guide
Fixed URL
Updated Deprecated features in Stx 8.0
Updated New Features supported in Stx 8.0
Updated Limitations / Workarounds applicable to Stx 8.0
Story: 2010446
Task: 46930
Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
Change-Id: I5dcab051fed6ec8155c9e5717f1a30e05ee813fb
Prepare glossary for reuse in non StX contexts.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I80842c90752d69fc9a522f00544fad91cc10f63f
- Generic changes from preview to GA
- Remove Reduced Scope section
- Technical updates to install section based on
Eric M. comments
- Release version updates
- Integrate install/pxe material in Install doc
- Comment out 'tree' output of pxe folder structure
- Incorporate patchset 4 review comments
- Removed operational-impacts. Moved to RNs.
- Removed technology-preview-known-issues. Was link to RNs.
- Patchset 6 updates
Story: 2010452
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: If2ef13583cec82bc0b85af180a45a825a24189bf
Since armada (deprecated) is being replaced by FluxCD in the
stx-openstack application [1], it is needed to also replace
the mentions of Armada in the stx-openstack related docs to
FluxCD.
[1] - https://review.opendev.org/c/starlingx/openstack-armada-app/+/862516
Signed-off-by: Rafael Falcao <rafael.vieirafalcao@windriver.com>
Change-Id: I0b2959630c970b51979db5eaefa81d59db477125
Link RN New Featurus section in Introduction doc
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I9cfbae5f524c520d4311d8a07d7aacb56b71b075
Add clarification and guidance for security and patching
limitations and work-arounds.
Correct copy/paste error.
Launchpad: 1990142
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I97dce2e0320b4fdceb43ad128963737745ea13df
- conditionalize "StarlingX" term to US builds.
- auto lex-sort list.
Incorporate patchset 1 review comments.
Incorporate patchset 2 review comments.
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Id1a27f1e333e9e07278b09eade1358a6134e899e
First pass - generic updates only. (command input/output to be done)
Address patchset 1 review comments.
Replace examples using openstack with metrics server
Remove DS app from application-list output
Additional migration to FluxCD (snmp, auditd)
Minor textual change.
Fix merge conflict.
Revert install r5 change.
Story: 2009138
Task: 45238
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ia40ff45f12ec7b7ffa859e0d8bb5535303870d83
Fixed commit message
Update with review comments for Patch Set 1
Added a new fault and performance section to the Introduction guide.
Change-Id: Ia9e38ab9e8b88430bf7f475200e8bb65b12e5a75
Temporarily commented out anything related to the Telemetry Services as this may be required in the future.
Signed-off-by: Elisamara Aoki Goncalves <elisamaraaoki.goncalves@windriver.com>
Change-Id: Iffb7874b1d8ba940b07fd1e43358d0dba4ed624e
Replaced some downstream terms with substitutions
Removed double dash (--) in file name and adjusted index
Fixed broken label
Incorporated comment from patchset 1
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I199481424a9630ad828c4570ac2ff0cbbb4f7c60
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
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>
Updates for patchset 2 review comments
Changed link depth of main Planning index and added some narrative guidance
Added planning/openstack as sibling of planning/kubernetes
Related additions to abbrevs.txt
Added max-workers substitution to accomodate StarlingX/vendor variants
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: Ibff9af74ab3f2c00958eff0e33c91465f1dab6b4
Signed-off-by: Stone <ronald.stone@windriver.com>
Replaced strings with substitutions in terms.rst to facilitate partner
reuse.
Additional substitutions defined in shared/abbrevs.
Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Idca8a924d750acd394607825c563657e67307a50
Added terms to StarlingX glossary to to increase SEO. Terms added are: StarlingX, open source cloud platform, edge computing. iot, virtualization, kubernetes cluster, node machines, and deployment tools. The full list of definitions can be found here: https://etherpad.opendev.org/p/StarlingX_Glossary
Change-Id: Ib6bdf9ab576a226e71820dc11606496f3c183155
Add a link to the StarlingX wiki from the introduction
projects section (for more info re project teams)
Change-Id: I7c41108810f79ebf28c2f5615e8fe9d8970c37b5
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Added link to STX project overview on the introduction page.
Change-Id: I8c6ecd16864c9fdb8dd8b18acadb5f2a00568f71
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
Per recent updates, updating use of 'compute' node to be
'worker' node. StarlingX uses worker nodes, and a 'compute' node
is a specialization of a worker node (OpenStack compute label applied).
- Update narrative text to use worker node
- Update shell scripts to use NODE instead of COMPUTE
Updated non-versioned content and R3 installation guides.
Change-Id: Ia3c5d354468f18efb79c823e5bfddf17e34998a9
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
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>
- Fix project URLs (broken from moving them to a diff location in docs).
- Update landing page URL for get started to go direct to virt aio-simplex.
Change-Id: Ibc6beed2d93716bbc47ec7c87b9292280d2a0b3e
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- 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>
Made spelling corrections.
Added punctuation to bullets.
Changed text to make bullets parallel.
Changed ie and eg to that is and for example.
Other general text edits for clarity.
Change-Id: I438b19f97bc0e289700ce533f6b5324721cc4bf4
Signed-off-by: MCamp859 <maryx.camp@intel.com>
- 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>
This change is the first round of new documents and cleanup of
the "StarlingX" Introduction section of the documentation.
* Created a new "Product Introduction" document.
* Added a new "Consuming StarlingX" document.
* Added a new "Key Concepts" document.
* And cleaned up some of the other document names to make them
fit in the TOC text box.
Story: 2005002
Change-Id: Ibe2023028c749a18fd83e610519350cf9058127d
Signed-off-by: Bruce Jones <bruce.e.jones@intel.com>
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>
