From 3a25ed287113574a4b34f78e077384273c3be0ee Mon Sep 17 00:00:00 2001 From: Kevin Owen Date: Wed, 8 Apr 2020 08:35:15 -0400 Subject: [PATCH] Issue #1147 Move docs modules to accessible directory Per modular documentation guidelines, modules should exist in an accessible location for potential use in multiple guides. --- docs/source/getting_started/master.adoc | 14 +++++++------- docs/source/getting_started/topics | 1 + .../assembly_accessing-the-openshift-cluster.adoc | 0 .../assembly_administrative-tasks.adoc | 0 .../assembly_configuring-codeready-containers.adoc | 0 .../content => topics}/assembly_installation.adoc | 0 .../assembly_introducing-codeready-containers.adoc | 0 .../content => topics}/assembly_networking.adoc | 0 .../assembly_troubleshooting.adoc | 0 .../assembly_using-codeready-containers.adoc | 0 ...n_about-codeready-containers-configuration.adoc | 0 .../con_about-codeready-containers.adoc | 0 ...ferences-from-production-openshift-install.adoc | 0 ...oc_accessing-the-openshift-cluster-with-oc.adoc | 0 .../proc_accessing-the-openshift-web-console.adoc | 0 .../proc_basic-troubleshooting.adoc | 0 .../proc_configuring-the-virtual-machine.adoc | 0 .../proc_deleting-the-virtual-machine.adoc | 0 ...ting-shell-access-to-the-openshift-cluster.adoc | 0 .../proc_installing-codeready-containers.adoc | 0 .../proc_setting-up-codeready-containers.adoc | 0 ...starting-codeready-containers-behind-proxy.adoc | 0 ...roc_starting-monitoring-alerting-telemetry.adoc | 6 +++--- .../proc_starting-the-virtual-machine.adoc | 0 .../proc_stopping-the-virtual-machine.adoc | 0 ...oc_troubleshooting-bundle-version-mismatch.adoc | 0 .../proc_troubleshooting-expired-certificates.adoc | 0 .../proc_upgrading-codeready-containers.adoc | 0 ...viewing-codeready-containers-configuration.adoc | 0 .../content => topics}/ref_dns-configuration.adoc | 0 .../ref_minimum-system-requirements.adoc | 0 .../ref_required-software-packages.adoc | 0 .../content => topics}/snip_crc-delete.adoc | 0 33 files changed, 11 insertions(+), 10 deletions(-) create mode 120000 docs/source/getting_started/topics rename docs/source/{getting_started/content => topics}/assembly_accessing-the-openshift-cluster.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_administrative-tasks.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_configuring-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_installation.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_introducing-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_networking.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_troubleshooting.adoc (100%) rename docs/source/{getting_started/content => topics}/assembly_using-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/con_about-codeready-containers-configuration.adoc (100%) rename docs/source/{getting_started/content => topics}/con_about-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/con_differences-from-production-openshift-install.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_accessing-the-openshift-cluster-with-oc.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_accessing-the-openshift-web-console.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_basic-troubleshooting.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_configuring-the-virtual-machine.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_deleting-the-virtual-machine.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_getting-shell-access-to-the-openshift-cluster.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_installing-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_setting-up-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_starting-codeready-containers-behind-proxy.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_starting-monitoring-alerting-telemetry.adoc (94%) rename docs/source/{getting_started/content => topics}/proc_starting-the-virtual-machine.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_stopping-the-virtual-machine.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_troubleshooting-bundle-version-mismatch.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_troubleshooting-expired-certificates.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_upgrading-codeready-containers.adoc (100%) rename docs/source/{getting_started/content => topics}/proc_viewing-codeready-containers-configuration.adoc (100%) rename docs/source/{getting_started/content => topics}/ref_dns-configuration.adoc (100%) rename docs/source/{getting_started/content => topics}/ref_minimum-system-requirements.adoc (100%) rename docs/source/{getting_started/content => topics}/ref_required-software-packages.adoc (100%) rename docs/source/{getting_started/content => topics}/snip_crc-delete.adoc (100%) diff --git a/docs/source/getting_started/master.adoc b/docs/source/getting_started/master.adoc index 1346356a26..437eb3d5cd 100644 --- a/docs/source/getting_started/master.adoc +++ b/docs/source/getting_started/master.adoc @@ -4,16 +4,16 @@ include::product-meta/product-attributes.adoc[] = Getting Started Guide -include::content/assembly_introducing-codeready-containers.adoc[leveloffset=+1] +include::topics/assembly_introducing-codeready-containers.adoc[leveloffset=+1] -include::content/assembly_installation.adoc[leveloffset=+1] +include::topics/assembly_installation.adoc[leveloffset=+1] -include::content/assembly_using-codeready-containers.adoc[leveloffset=+1] +include::topics/assembly_using-codeready-containers.adoc[leveloffset=+1] -include::content/assembly_configuring-codeready-containers.adoc[leveloffset=+1] +include::topics/assembly_configuring-codeready-containers.adoc[leveloffset=+1] -include::content/assembly_networking.adoc[leveloffset=+1] +include::topics/assembly_networking.adoc[leveloffset=+1] -include::content/assembly_administrative-tasks.adoc[leveloffset=+1] +include::topics/assembly_administrative-tasks.adoc[leveloffset=+1] -include::content/assembly_troubleshooting.adoc[leveloffset=+1] +include::topics/assembly_troubleshooting.adoc[leveloffset=+1] diff --git a/docs/source/getting_started/topics b/docs/source/getting_started/topics new file mode 120000 index 0000000000..5983d9292c --- /dev/null +++ b/docs/source/getting_started/topics @@ -0,0 +1 @@ +../topics \ No newline at end of file diff --git a/docs/source/getting_started/content/assembly_accessing-the-openshift-cluster.adoc b/docs/source/topics/assembly_accessing-the-openshift-cluster.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_accessing-the-openshift-cluster.adoc rename to docs/source/topics/assembly_accessing-the-openshift-cluster.adoc diff --git a/docs/source/getting_started/content/assembly_administrative-tasks.adoc b/docs/source/topics/assembly_administrative-tasks.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_administrative-tasks.adoc rename to docs/source/topics/assembly_administrative-tasks.adoc diff --git a/docs/source/getting_started/content/assembly_configuring-codeready-containers.adoc b/docs/source/topics/assembly_configuring-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_configuring-codeready-containers.adoc rename to docs/source/topics/assembly_configuring-codeready-containers.adoc diff --git a/docs/source/getting_started/content/assembly_installation.adoc b/docs/source/topics/assembly_installation.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_installation.adoc rename to docs/source/topics/assembly_installation.adoc diff --git a/docs/source/getting_started/content/assembly_introducing-codeready-containers.adoc b/docs/source/topics/assembly_introducing-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_introducing-codeready-containers.adoc rename to docs/source/topics/assembly_introducing-codeready-containers.adoc diff --git a/docs/source/getting_started/content/assembly_networking.adoc b/docs/source/topics/assembly_networking.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_networking.adoc rename to docs/source/topics/assembly_networking.adoc diff --git a/docs/source/getting_started/content/assembly_troubleshooting.adoc b/docs/source/topics/assembly_troubleshooting.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_troubleshooting.adoc rename to docs/source/topics/assembly_troubleshooting.adoc diff --git a/docs/source/getting_started/content/assembly_using-codeready-containers.adoc b/docs/source/topics/assembly_using-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/assembly_using-codeready-containers.adoc rename to docs/source/topics/assembly_using-codeready-containers.adoc diff --git a/docs/source/getting_started/content/con_about-codeready-containers-configuration.adoc b/docs/source/topics/con_about-codeready-containers-configuration.adoc similarity index 100% rename from docs/source/getting_started/content/con_about-codeready-containers-configuration.adoc rename to docs/source/topics/con_about-codeready-containers-configuration.adoc diff --git a/docs/source/getting_started/content/con_about-codeready-containers.adoc b/docs/source/topics/con_about-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/con_about-codeready-containers.adoc rename to docs/source/topics/con_about-codeready-containers.adoc diff --git a/docs/source/getting_started/content/con_differences-from-production-openshift-install.adoc b/docs/source/topics/con_differences-from-production-openshift-install.adoc similarity index 100% rename from docs/source/getting_started/content/con_differences-from-production-openshift-install.adoc rename to docs/source/topics/con_differences-from-production-openshift-install.adoc diff --git a/docs/source/getting_started/content/proc_accessing-the-openshift-cluster-with-oc.adoc b/docs/source/topics/proc_accessing-the-openshift-cluster-with-oc.adoc similarity index 100% rename from docs/source/getting_started/content/proc_accessing-the-openshift-cluster-with-oc.adoc rename to docs/source/topics/proc_accessing-the-openshift-cluster-with-oc.adoc diff --git a/docs/source/getting_started/content/proc_accessing-the-openshift-web-console.adoc b/docs/source/topics/proc_accessing-the-openshift-web-console.adoc similarity index 100% rename from docs/source/getting_started/content/proc_accessing-the-openshift-web-console.adoc rename to docs/source/topics/proc_accessing-the-openshift-web-console.adoc diff --git a/docs/source/getting_started/content/proc_basic-troubleshooting.adoc b/docs/source/topics/proc_basic-troubleshooting.adoc similarity index 100% rename from docs/source/getting_started/content/proc_basic-troubleshooting.adoc rename to docs/source/topics/proc_basic-troubleshooting.adoc diff --git a/docs/source/getting_started/content/proc_configuring-the-virtual-machine.adoc b/docs/source/topics/proc_configuring-the-virtual-machine.adoc similarity index 100% rename from docs/source/getting_started/content/proc_configuring-the-virtual-machine.adoc rename to docs/source/topics/proc_configuring-the-virtual-machine.adoc diff --git a/docs/source/getting_started/content/proc_deleting-the-virtual-machine.adoc b/docs/source/topics/proc_deleting-the-virtual-machine.adoc similarity index 100% rename from docs/source/getting_started/content/proc_deleting-the-virtual-machine.adoc rename to docs/source/topics/proc_deleting-the-virtual-machine.adoc diff --git a/docs/source/getting_started/content/proc_getting-shell-access-to-the-openshift-cluster.adoc b/docs/source/topics/proc_getting-shell-access-to-the-openshift-cluster.adoc similarity index 100% rename from docs/source/getting_started/content/proc_getting-shell-access-to-the-openshift-cluster.adoc rename to docs/source/topics/proc_getting-shell-access-to-the-openshift-cluster.adoc diff --git a/docs/source/getting_started/content/proc_installing-codeready-containers.adoc b/docs/source/topics/proc_installing-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/proc_installing-codeready-containers.adoc rename to docs/source/topics/proc_installing-codeready-containers.adoc diff --git a/docs/source/getting_started/content/proc_setting-up-codeready-containers.adoc b/docs/source/topics/proc_setting-up-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/proc_setting-up-codeready-containers.adoc rename to docs/source/topics/proc_setting-up-codeready-containers.adoc diff --git a/docs/source/getting_started/content/proc_starting-codeready-containers-behind-proxy.adoc b/docs/source/topics/proc_starting-codeready-containers-behind-proxy.adoc similarity index 100% rename from docs/source/getting_started/content/proc_starting-codeready-containers-behind-proxy.adoc rename to docs/source/topics/proc_starting-codeready-containers-behind-proxy.adoc diff --git a/docs/source/getting_started/content/proc_starting-monitoring-alerting-telemetry.adoc b/docs/source/topics/proc_starting-monitoring-alerting-telemetry.adoc similarity index 94% rename from docs/source/getting_started/content/proc_starting-monitoring-alerting-telemetry.adoc rename to docs/source/topics/proc_starting-monitoring-alerting-telemetry.adoc index 298095f2fc..061eb92188 100644 --- a/docs/source/getting_started/content/proc_starting-monitoring-alerting-telemetry.adoc +++ b/docs/source/topics/proc_starting-monitoring-alerting-telemetry.adoc @@ -20,7 +20,7 @@ For more information, see <>. ** On Linux or {mac}: + -[subs="+quotes,attributes"] +[subs="+quotes"] ---- $ oc get clusterversion version -ojsonpath='{range .spec.overrides[*]}{.name}{"\n"}{end}' | nl -v 0 ---- @@ -28,14 +28,14 @@ $ oc get clusterversion version -ojsonpath='{range .spec.overrides[*]}{.name}{"\ // TODO: Revise the command for PowerShell in the future. ** On {msw} using PowerShell: + -[subs="+quotes,attributes"] +[subs="+quotes"] ---- PS> oc get clusterversion version -ojsonpath='{range .spec.overrides[*]}{.name}{"\n"}{end}' | % {$nl++;"`t$($nl-1) `t $_"};$nl=0 ---- . Start monitoring, alerting, and telemetry services using the identified numeric index: + -[subs="+quotes,attributes"] +[subs="+quotes"] ---- $ oc patch clusterversion/version --type='json' -p '[{"op":"remove", "path":"/spec/overrides/__"}]' -oyaml ---- diff --git a/docs/source/getting_started/content/proc_starting-the-virtual-machine.adoc b/docs/source/topics/proc_starting-the-virtual-machine.adoc similarity index 100% rename from docs/source/getting_started/content/proc_starting-the-virtual-machine.adoc rename to docs/source/topics/proc_starting-the-virtual-machine.adoc diff --git a/docs/source/getting_started/content/proc_stopping-the-virtual-machine.adoc b/docs/source/topics/proc_stopping-the-virtual-machine.adoc similarity index 100% rename from docs/source/getting_started/content/proc_stopping-the-virtual-machine.adoc rename to docs/source/topics/proc_stopping-the-virtual-machine.adoc diff --git a/docs/source/getting_started/content/proc_troubleshooting-bundle-version-mismatch.adoc b/docs/source/topics/proc_troubleshooting-bundle-version-mismatch.adoc similarity index 100% rename from docs/source/getting_started/content/proc_troubleshooting-bundle-version-mismatch.adoc rename to docs/source/topics/proc_troubleshooting-bundle-version-mismatch.adoc diff --git a/docs/source/getting_started/content/proc_troubleshooting-expired-certificates.adoc b/docs/source/topics/proc_troubleshooting-expired-certificates.adoc similarity index 100% rename from docs/source/getting_started/content/proc_troubleshooting-expired-certificates.adoc rename to docs/source/topics/proc_troubleshooting-expired-certificates.adoc diff --git a/docs/source/getting_started/content/proc_upgrading-codeready-containers.adoc b/docs/source/topics/proc_upgrading-codeready-containers.adoc similarity index 100% rename from docs/source/getting_started/content/proc_upgrading-codeready-containers.adoc rename to docs/source/topics/proc_upgrading-codeready-containers.adoc diff --git a/docs/source/getting_started/content/proc_viewing-codeready-containers-configuration.adoc b/docs/source/topics/proc_viewing-codeready-containers-configuration.adoc similarity index 100% rename from docs/source/getting_started/content/proc_viewing-codeready-containers-configuration.adoc rename to docs/source/topics/proc_viewing-codeready-containers-configuration.adoc diff --git a/docs/source/getting_started/content/ref_dns-configuration.adoc b/docs/source/topics/ref_dns-configuration.adoc similarity index 100% rename from docs/source/getting_started/content/ref_dns-configuration.adoc rename to docs/source/topics/ref_dns-configuration.adoc diff --git a/docs/source/getting_started/content/ref_minimum-system-requirements.adoc b/docs/source/topics/ref_minimum-system-requirements.adoc similarity index 100% rename from docs/source/getting_started/content/ref_minimum-system-requirements.adoc rename to docs/source/topics/ref_minimum-system-requirements.adoc diff --git a/docs/source/getting_started/content/ref_required-software-packages.adoc b/docs/source/topics/ref_required-software-packages.adoc similarity index 100% rename from docs/source/getting_started/content/ref_required-software-packages.adoc rename to docs/source/topics/ref_required-software-packages.adoc diff --git a/docs/source/getting_started/content/snip_crc-delete.adoc b/docs/source/topics/snip_crc-delete.adoc similarity index 100% rename from docs/source/getting_started/content/snip_crc-delete.adoc rename to docs/source/topics/snip_crc-delete.adoc