From 8d34ec2d1aa22a0a956550a554b801bbb4e11183 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Wed, 24 Jan 2024 14:52:00 +0100 Subject: [PATCH] fix: docs improvements (#2675) * fix: docs improvements Signed-off-by: Anatolii Bazko * Update modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc Co-authored-by: Jana Vrbkova --------- Signed-off-by: Anatolii Bazko Co-authored-by: Jana Vrbkova --- .../examples/snip_che-installing-che.adoc | 6 +++--- modules/administration-guide/nav.adoc | 6 +++--- .../finding-the-fully-qualified-domain-name-fqdn.adoc | 8 +++----- .../pages/installing-che-in-the-cloud.adoc | 3 +++ .../pages/installing-che-locally.adoc | 8 ++------ .../pages/installing-che-on-microsoft-azure.adoc | 6 +++--- .../partials/proc_configuring-dns-on-microsoft-azure.adoc | 3 ++- ...ts-encrypt-certificate-for-che-on-microsoft-azure.adoc | 3 ++- 8 files changed, 21 insertions(+), 22 deletions(-) diff --git a/modules/administration-guide/examples/snip_che-installing-che.adoc b/modules/administration-guide/examples/snip_che-installing-che.adoc index f6161d27d3..8a360e1f3a 100644 --- a/modules/administration-guide/examples/snip_che-installing-che.adoc +++ b/modules/administration-guide/examples/snip_che-installing-che.adoc @@ -4,7 +4,7 @@ The installation method depends on the target platform and the environment restr .Using {prod-short} as a service -* link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[{prod-short} hosted by RedHat] +* link:https://www.eclipse.org/che/docs/stable/hosted-che/hosted-che/[{prod-short} hosted by RedHat] .Installing {prod-short} in the cloud @@ -13,7 +13,7 @@ You can deploy only one instance of {prod-short} per cluster. * xref:installing-che-on-openshift-using-cli.adoc[] * xref:installing-che-on-openshift-using-the-web-console.adoc[] * xref:installing-che-in-a-restricted-environment.adoc[] - +* xref:installing-che-on-microsoft-azure.adoc[] .Installing {prod-short} on a local single-node cluster @@ -21,4 +21,4 @@ Single-node clusters are suited only for testing or development. Do *not* use su * xref:installing-che-on-red-hat-openshift-local.adoc[] * xref:installing-che-on-minikube.adoc[] - +* xref:installing-che-on-minikube-keycloak-oidc.adoc[] diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index fe54688ae7..df151325ad 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -15,10 +15,10 @@ *** xref:user-workspaces.adoc[] ** xref:calculating-che-resource-requirements.adoc[] * xref:installing-che.adoc[] -** xref:installing-che-on-openshift-using-cli.adoc[] -** xref:installing-che-on-openshift-using-the-web-console.adoc[] -** xref:installing-che-in-a-restricted-environment.adoc[] ** xref:installing-che-in-the-cloud.adoc[] +*** xref:installing-che-on-openshift-using-cli.adoc[] +*** xref:installing-che-on-openshift-using-the-web-console.adoc[] +*** xref:installing-che-in-a-restricted-environment.adoc[] *** xref:installing-che-on-microsoft-azure.adoc[] ** xref:installing-che-locally.adoc[] *** xref:installing-che-on-red-hat-openshift-local.adoc[] diff --git a/modules/administration-guide/pages/finding-the-fully-qualified-domain-name-fqdn.adoc b/modules/administration-guide/pages/finding-the-fully-qualified-domain-name-fqdn.adoc index 2fc498c4f6..b587fddd00 100644 --- a/modules/administration-guide/pages/finding-the-fully-qualified-domain-name-fqdn.adoc +++ b/modules/administration-guide/pages/finding-the-fully-qualified-domain-name-fqdn.adoc @@ -9,20 +9,18 @@ You can get the fully qualified domain name (FQDN) of your organization's instance of {prod-short} on the command line or in the OpenShift web console. -TIP: You can find the FQDN for your organization's {prod-short} instance in the *Administrator* view of the OpenShift web console as follows. Go to *Operators* -> *OperatorHub* -> *Installed Operators* -> *{prod} instance Specification* -> *{prod-checluster}* -> *{prod} URL*. +TIP: You can find the FQDN for your organization's {prod-short} instance in the *Administrator* view of the OpenShift web console as follows. Go to *Operators* -> *Installed Operators* -> *{prod} instance Specification* -> *{prod-checluster}* -> *{prod} URL*. .Prerequisites * An active `oc` session with administrative permissions to the OpenShift cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI]. -* `{prod-cli}`. See xref:installing-the-chectl-management-tool.adoc[]. .Procedure . Run the following command: + -[subs="+attributes,+quotes"] +[source,bash,subs="+attributes,+quotes"] ---- -$ {prod-cli} server:status +{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.status.cheURL}' ---- -. Copy the *{prod} URL* without the trailing `/dashboard/`. diff --git a/modules/administration-guide/pages/installing-che-in-the-cloud.adoc b/modules/administration-guide/pages/installing-che-in-the-cloud.adoc index 2487fc5217..fe6b8218f1 100644 --- a/modules/administration-guide/pages/installing-che-in-the-cloud.adoc +++ b/modules/administration-guide/pages/installing-che-in-the-cloud.adoc @@ -18,4 +18,7 @@ Deploy and run {prod} in the cloud. Follow the instructions below to start the {prod-short} Server in the cloud using the `{prod-cli}` tool. +* xref:installing-che-on-openshift-using-cli.adoc[] +* xref:installing-che-on-openshift-using-the-web-console.adoc[] +* xref:installing-che-in-a-restricted-environment.adoc[] * xref:installing-che-on-microsoft-azure.adoc[] diff --git a/modules/administration-guide/pages/installing-che-locally.adoc b/modules/administration-guide/pages/installing-che-locally.adoc index 8136cb7fd2..a72cb7efc4 100644 --- a/modules/administration-guide/pages/installing-che-locally.adoc +++ b/modules/administration-guide/pages/installing-che-locally.adoc @@ -15,14 +15,10 @@ This section contains instructions for deploying and running {prod} locally, on * `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[]. -.Deploying {prod-short} on Minikube in 3 minutes using {prod-cli} -++++ - -++++ - == Deploying {prod-short} locally using {prod-cli} -Choose one of the following procedures to start the {prod-short} Server using the `{prod-cli}` tool. +Choose one of the following procedures to deploy the {prod-short} using the `{prod-cli}` tool. * xref:installing-che-on-red-hat-openshift-local.adoc[] * xref:installing-che-on-minikube.adoc[] +* xref:installing-che-on-minikube-keycloak-oidc.adoc[] diff --git a/modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc b/modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc index 2571cebc55..2400fc3c57 100644 --- a/modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc +++ b/modules/administration-guide/pages/installing-che-on-microsoft-azure.adoc @@ -1,10 +1,10 @@ :_content-type: ASSEMBLY -:description: Installing and setting up {prod-short} on Microsoft Azure +:description: Installing {prod-short} on Microsoft Azure :keywords: overview, installing-che-on-microsoft-azure -:navtitle: Installing and setting up {prod-short} on Microsoft Azure +:navtitle: Installing {prod-short} on Microsoft Azure [id="installing-{prod-id-short}-on-microsoft-azure"] -= Installing and setting up {prod-short} on Microsoft Azure += Installing {prod-short} on Microsoft Azure Microsoft Azure is a cloud computing service for building, testing, deploying, and managing applications and services through Microsoft-managed data centers. diff --git a/modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc b/modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc index e59478c553..37735d3122 100644 --- a/modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc +++ b/modules/administration-guide/partials/proc_configuring-dns-on-microsoft-azure.adoc @@ -44,10 +44,11 @@ az network dns record-set a add-record \ If you use a registrar such as GoDaddy, you will need to add the following two DNS records in your registrar and point them to the IP address of the ingress controller: + * type: `A` * names: `@` and `*` ==== -+ + .Additional resources * link:https://learn.microsoft.com/en-us/azure/dns/dns-getstarted-cli[Create a Microsoft Azure DNS zone and record using Microsoft Azure CLI] diff --git a/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc b/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc index 123047920c..aebbe0bc3c 100644 --- a/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc +++ b/modules/administration-guide/partials/proc_creating-lets-encrypt-certificate-for-che-on-microsoft-azure.adoc @@ -103,10 +103,11 @@ EOF [IMPORTANT] ==== If you use a registrar such as GoDaddy, you need to duplicate the following DNS records in your registrar: + * type: `TXT` * name: `_acme-challenge`. ==== -+ + .Additional resources * link:https://cert-manager.io/docs/tutorials/getting-started-aks-letsencrypt[Deploy cert-manager on Azure Kubernetes Service (AKS) and use Let's Encrypt to sign a certificate for an HTTPS website]