13 Commits

Author SHA1 Message Date
Ron Stone
98d01b5049 TOC structure changes
Conditionalized use of "Contents" heading in Kubernetes and
OpenStack subindexes.
Make "Contents" a common include, overwritable per book
Conditionally pull in kubernetes and OpenStack descriptions from
each book index to kubernetes/index and openstack/index for partner
use
Deleted index.rs1 topics from DITA import

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I857a1dbb567a0bf609b449e8260b2f8801a339fb
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
2021-09-17 11:22:40 -04:00
Ron Stone
dcf0c9a372 Deploy folder structure
Move content under deploy/kubernetes as per convention.
This is required for DS builds.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I5da5b554ea274cbd3b1a2c0f47bf649df1080173
2021-08-04 08:51:01 -04:00
egoncalv
c12cf2bc59 Replaced relase version to nn.nn
Solved building and merge conflict problem.

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: I9272fa6246bd60ace6a5f7ba64fdb4181b1e4721
2021-06-14 20:16:28 -03:00
egoncalv
cd1f0e68ff Inclusive Language Updates
Patch 1: Worked on Bart and Mary's comments.

Patch 2: Worked on Bart's comments.

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: Ida78101e923dbce32a1c17ba45becb4b62f17c4d
2021-06-11 17:18:40 -03:00
MCamp859
f9aaaa90a1 Add STX condition to deploy index
Add STX condition for Edgeworker guide in deployment
configurations index file.

Change-Id: I02bac8247bac7af8b519c8f9c5244e4287be2ea1
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-06-04 16:18:05 -04:00
MCamp859
62ac1ea6fe Editorial updates to edgeworker guide
Follow-on to review 774595:

Added reference label to edgeworker guide.
Edited text for format and grammar to align with other guides.
Added starlingx condition to Note in install guides that refer
to Edgeworker guide.

Included reviewer feedback.
Rebased to fix merge conflict.

Change-Id: I2952aa5e57e399876faaef98021d9032dacfe7c8
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-06-01 11:24:31 -04:00
MCamp859
d235b95056 R5 updates to landing page and installation
Patch set 5: Updated R5 RN.

Patch set 4: Resolved merge confict.

Patch set 3: Removed R5 install guides.
Local docs build is successful.

Patch set 2: Added R6 install guides.
Removed R1-R4 install guides.
R5 will be removed next patch set.

Updated main docs landing page with R5 links.
Installation index page: promoted R5 to supported, moved R4 to
archive section, created R6 (latest) section.

Change-Id: Ic0e0409f2385a9a6f29b83a2eda12753ea4ac1a3
Signed-off-by: MCamp859 <maryx.camp@intel.com>
2021-05-31 11:46:08 -04:00
Zuul
ef1c5ac068 Merge "Deploy edgeworker nodes" 2021-05-26 20:22:36 +00:00
Mingyuan Qi
d17e0951f1 Deploy edgeworker nodes
Add a page for edgeworker node deployment guide.

Story: 2008129
Task: 41784

Change-Id: I3d6deff17de9950e8f670e03144927c1cc4ee07e
Signed-off-by: Mingyuan Qi <mingyuan.qi@intel.com>
2021-05-26 23:52:17 +08:00
egoncalv
31f084792c Editorial Updates for all Upstream / Downstream Guides
Acted on Greg's comments on Deployment Configurations Guide

Patch 1: Acted on Greg's comment.

https://review.opendev.org/c/starlingx/docs/+/791820

Signed-off-by: egoncalv <elisamaraaoki.goncalves@windriver.com>
Change-Id: I4d641529974dc15670e2fb1e3afa0aa0277c467b
2021-05-18 15:34:43 -03:00
Stone
333b4346aa Changed relative paths to absolute
Sphinx considers the "source" dir to be it's root. Image or figure paths such as:

.. image:: ../deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

can lead to build time behavior like the following under some circumstances:

copying images... [ 11%] deploy/../deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

whereas the absolute path:

.. image:: /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

behaves predictably.

copying images... [ 11%] /deploy_install_guides/r5_release/figures/starlingx-deployment-options-controller-storage.png

So changed a handful of relative links to be absolute from the source root.

Signed-off-by: Stone <ronald.stone@windriver.com>
Change-Id: Id63e5949a78959a5f570b835eac658b42440fbcd
2021-02-19 06:45:53 -05:00
Juanita-Balaraj
0c4aa91ca4 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>
2021-01-11 23:40:36 -05:00
Stone
b250326272 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-12-03 10:10:03 -05:00