From f3d99e970375cb10c64293a05744cb5fd4d1c921 Mon Sep 17 00:00:00 2001 From: Feilian Xie Date: Sat, 20 Jan 2024 19:48:24 +0800 Subject: [PATCH] List disabled operators in the docs. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fabrice Flore-Thébault --- README.adoc | 2 +- docs/README.adoc | 2 +- docs/modules/getting_started/pages/introducing.adoc | 2 +- .../con_differences-from-production-openshift-install.adoc | 4 ++++ 4 files changed, 7 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index bf2b1b6bfe..9399d1af07 100644 --- a/README.adoc +++ b/README.adoc @@ -46,7 +46,7 @@ See the link:https://crc-org.github.io/crc/[CRC Getting Started Guide]. === Building the documentation -You can find the source files for the documentation in the link:./docs/source[docs/source] directory. +You can find the source files for the documentation in the link:./docs[docs] directory. To build the formatted documentation, link:https://github.com/containers/libpod/blob/master/install.md[install podman] then use the following: diff --git a/docs/README.adoc b/docs/README.adoc index 17f95dd50e..632629114b 100644 --- a/docs/README.adoc +++ b/docs/README.adoc @@ -12,4 +12,4 @@ ---- $ make docs_serve ---- - +The documentation will be available locally at http://localhost:8088/. diff --git a/docs/modules/getting_started/pages/introducing.adoc b/docs/modules/getting_started/pages/introducing.adoc index df5459e291..cbfc4ef401 100644 --- a/docs/modules/getting_started/pages/introducing.adoc +++ b/docs/modules/getting_started/pages/introducing.adoc @@ -1,4 +1,4 @@ -:description: Introducting {prod} +:description: Introducing {prod} [id="introducing_{context}"] = Introducing {rh-prod} diff --git a/docs/modules/getting_started/partials/con_differences-from-production-openshift-install.adoc b/docs/modules/getting_started/partials/con_differences-from-production-openshift-install.adoc index 10ba53b287..d3ffa650fb 100644 --- a/docs/modules/getting_started/partials/con_differences-from-production-openshift-install.adoc +++ b/docs/modules/getting_started/partials/con_differences-from-production-openshift-install.adoc @@ -8,6 +8,10 @@ Upgrading the {ocp} version might cause issues that are difficult to reproduce. * It uses a single node, which behaves as both a control plane and worker node. * It disables the Cluster Monitoring Operator by default. This disabled Operator causes the corresponding part of the web console to be non-functional. +* It disables the following operators: +** Cloud Credential Operator. +** Cluster Autoscaler Operator. +** Cloud Controller Manager Operator. * The {ocp} cluster runs in a virtual machine known as an __instance__. This might cause other differences, particularly with external networking.