Documentation fixes

thegridman · thegridman · commit 83b5f680b18f · 2025-05-16T15:55:53.000+03:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
diff --git a/docs/about/01_overview.adoc b/docs/about/01_overview.adoc
@@ -23,7 +23,7 @@ Quick start guide to running your first Coherence cluster using the Coherence Op
 
 [CARD]
 .Install
-[icon=fa-save,link=docs/installation/01_installation.adoc]
+[icon=fa-save,link=docs/installation/001_installation.adoc]
 --
 Installing and running the Coherence Operator.
 --
diff --git a/docs/about/03_quickstart.adoc b/docs/about/03_quickstart.adoc
@@ -15,7 +15,7 @@ to install a simple Coherence cluster.
 
 == Prerequisites
 
-Ensure that the <<docs/installation/01_installation.adoc,Coherence Operator prerequisites>> are available.
+Ensure that the <<docs/installation/001_installation.adoc,Coherence Operator prerequisites>> are available.
 
 == 1. Install the Coherence Operator
 
@@ -71,7 +71,7 @@ or with Helm v2
 helm install --namespace coherence-test  --name operator coherence/coherence-operator
 ----
 
-See the <<docs/installation/01_installation.adoc, full install guide>> for more details.
+See the <<docs/installation/001_installation.adoc, full install guide>> for more details.
 
 
 == 2. Install a Coherence Deployment
diff --git a/docs/coherence/021_member_identity.adoc b/docs/coherence/021_member_identity.adoc
@@ -166,7 +166,7 @@ and the Node label used to get the value for the rack will be `identity/rack`.
 
 ==== Using Kubectl or Kustomize
 
-If using `kubectl` or `kustomize` as described in the <<docs/installation/01_installation.adoc,Installation Guide>>
+If using `kubectl` or `kustomize` as described in the <<docs/installation/001_installation.adoc,Installation Guide>>
 the additional environment variables can be applied using `kustomize` commands.
 
 [source,bash]
diff --git a/docs/installation/020_RBAC.adoc b/docs/installation/020_RBAC.adoc
@@ -29,7 +29,7 @@ Assuming that all the above reductions in features are acceptable then the Opera
 
 == Install the Operator Without ClusterRoles
 
-The two methods of installing the Operator discussed in the <<docs/installation/01_installation.adoc,Install Guide>> can be used to install the Operator without ClusterRoles.
+The two methods of installing the Operator discussed in the <<docs/installation/001_installation.adoc,Install Guide>> can be used to install the Operator without ClusterRoles.
 
 === Manually Install CRDs
 
@@ -78,7 +78,7 @@ kubectl apply -f crd-small/coherence.oracle.com_coherence.yaml
 
 === Install Using Helm
 
-The Operator can be installed from the Helm chart, as described in the <<docs/installation/01_installation.adoc,Install Guide>>.
+The Operator can be installed from the Helm chart, as described in the <<docs/installation/001_installation.adoc,Install Guide>>.
 The Helm chart contains values that control whether cluster roles are created when installing the chart. To install the chart without any cluster roles set the `clusterRoles` value to `false`.
 
 [source,bash]
@@ -114,7 +114,7 @@ helm install  \
 
 === Install Using Kustomize
 
-The Operator can be installed using Kustomize with the manifest files, as described in the <<docs/installation/01_installation.adoc,Install Guide>>.
+The Operator can be installed using Kustomize with the manifest files, as described in the <<docs/installation/001_installation.adoc,Install Guide>>.
 
 ==== Exclude the ClusterRole Manifests
 
diff --git a/examples/020_hello_world/README.adoc b/examples/020_hello_world/README.adoc
@@ -21,7 +21,7 @@ image:GitHub-Mark-32px.png[] The complete source code for this example is in the
 === Install the Operator
 
 If you have not already done so, you need to install the Coherence Operator.
-There are a few simple ways to do this as described in the <<docs/installation/01_installation.adoc,Installation Guide>>
+There are a few simple ways to do this as described in the <<docs/installation/001_installation.adoc,Installation Guide>>
 
 === A Default Coherence Cluster
 
diff --git a/examples/021_deployment/README.adoc b/examples/021_deployment/README.adoc
@@ -127,7 +127,7 @@ You also need to prefix the image name in the `yaml` files below.
 == Install the Coherence Operator
 
 Install the Coherence Operator using your preferred method in the Operator
-https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/01_installation[Installation Guide]
+https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/001_installation[Installation Guide]
 
 Confirm the operator is running, for example if the operator is installed into the `coherence-example` namespace:
 [source,bash]
diff --git a/examples/025_extend_client/README.adoc b/examples/025_extend_client/README.adoc
@@ -31,7 +31,7 @@ If you have not already done so, you should build the image from that example, s
 ==== Install the Operator
 
 If you have not already done so, you need to install the Coherence Operator.
-There are a few simple ways to do this as described in the <<docs/installation/01_installation.adoc,Installation Guide>>
+There are a few simple ways to do this as described in the <<docs/installation/001_installation.adoc,Installation Guide>>
 
 
 == The Client Application
diff --git a/examples/090_tls/README.adoc b/examples/090_tls/README.adoc
@@ -55,7 +55,7 @@ If you do not want to use Cert Manager to try this example then a long as you ha
 [#install_operator]
 === Install the Operator
 
-To run the examples below, you will need to have installed the Coherence Operator, do this using whatever method you prefer from the https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/01_installation[Installation Guide]
+To run the examples below, you will need to have installed the Coherence Operator, do this using whatever method you prefer from the https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/001_installation[Installation Guide]
 
 [#setup_cert_manager]
 === Setting Up Cert-Manager
diff --git a/examples/100_federation/README.adoc b/examples/100_federation/README.adoc
@@ -139,7 +139,7 @@ For each of the OKE clusters, carry out the following
 ==== 1. Install the Coherence Operator
 
 To run the examples below, you will need to have installed the Coherence Operator,
-do this using whatever method you prefer from the https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/01_installation[Installation Guide].
+do this using whatever method you prefer from the https://oracle.github.io/coherence-operator/docs/latest/#/docs/installation/001_installation[Installation Guide].
 
 [source,bash]
 ----
diff --git a/examples/400_Istio/README.adoc b/examples/400_Istio/README.adoc
@@ -164,7 +164,7 @@ kubectl -n coherence apply istio-operator.yaml
 ----
 
 You can then install the operator using your preferred method in the
-Operator <<docs/installation/01_installation.adoc,Installation Guide>>.
+Operator <<docs/installation/001_installation.adoc,Installation Guide>>.
 
 After installed operator, use the following command to confirm the operator is running:
 
diff --git a/examples/910_polyglot_demo/README.adoc b/examples/910_polyglot_demo/README.adoc
@@ -133,7 +133,7 @@ When you see the following message, you can continue.
 deployment.apps/coherence-operator-controller-manager condition met
 ----
 
-See the <<docs/installation/01_installation.adoc,Installation Guide>> for more information about installing the Coherence Operator.
+See the <<docs/installation/001_installation.adoc,Installation Guide>> for more information about installing the Coherence Operator.
 
 [#pre-4]
 ==== Download Additional Software (Optional)
diff --git a/hack/github/github-pages.sh b/hack/github/github-pages.sh
@@ -7,48 +7,59 @@
 
 set -o -v errexit
 
-ROOT_DIR=$(pwd)
-GITHUB_REPO=$(git config --get remote.origin.url)
+if [ "${WORKSPACE}" == "" ]
+then
+  WORKSPACE=$(pwd)
+fi
+
+if [ "${OPERATOR_VERSION}" == "" ]
+then
+  OPERATOR_VERSION=$(cat "${BUILD_OUTPUT}/OPERATOR_VERSION.txt")
+fi
+
 GITHUB_REPO=https://github.com/oracle/coherence-operator.git
-BUILD_OUTPUT=${ROOT_DIR}/build/_output
-BUILD_GH_PAGES="${ROOT_DIR}/gh-pages"
-VERSION=$(cat "${BUILD_OUTPUT}/version.txt")
+BUILD_OUTPUT=${WORKSPACE}/build/_output
+BUILD_GH_PAGES="${WORKSPACE}/gh-pages"
 
-@echo "ROOT_DIR="${ROOT_DIR}""
+@echo "WORKSPACE="${WORKSPACE}""
 @echo "GITHUB_REPO=${GITHUB_REPO}"
-@echo "VERSION=${VERSION}"
+@echo "OPERATOR_VERSION=${OPERATOR_VERSION}"
 
 rm -rf ${BUILD_GH_PAGES}
-git clone -b gh-pages --single-branch ${GITHUB_REPO} "${ROOT_DIR}/gh-pages"
+git clone -b gh-pages --single-branch ${GITHUB_REPO} "${WORKSPACE}/gh-pages"
 cd ${BUILD_GH_PAGES}
 
+GIT_ORIGIN=$(git config remote.origin.url)
+GIT_URL=$(echo ${GIT_ORIGIN} | sed -e s#://#://${GITHUB_USERNAME}:${GITHUB_TOKEN}@#)
+git remote set-url origin "${GIT_URL}"
+
 mkdir -p ${BUILD_GH_PAGES}/dashboards || true
-rm -rf ${BUILD_GH_PAGES}/dashboards/${VERSION} || true
-cp -R ${BUILD_OUTPUT}/dashboards/${VERSION} ${BUILD_GH_PAGES}/dashboards/
-git add dashboards/${VERSION}/*
+rm -rf ${BUILD_GH_PAGES}/dashboards/${OPERATOR_VERSION} || true
+cp -R ${BUILD_OUTPUT}/dashboards/${OPERATOR_VERSION} ${BUILD_GH_PAGES}/dashboards/
+git add dashboards/${OPERATOR_VERSION}/*
 rm -rf ${BUILD_GH_PAGES}/dashboards/latest || true
-cp -R ${BUILD_GH_PAGES}/dashboards/${VERSION} ${BUILD_GH_PAGES}/dashboards/latest
+cp -R ${BUILD_GH_PAGES}/dashboards/${OPERATOR_VERSION} ${BUILD_GH_PAGES}/dashboards/latest
 git add -A dashboards/latest/*
 
-mkdir ${BUILD_GH_PAGES}/docs/${VERSION} || true
-rm -rf ${BUILD_GH_PAGES}/docs/${VERSION}/ || true
-cp -R ${BUILD_OUTPUT}/docs ${BUILD_GH_PAGES}/docs/${VERSION}/
+mkdir ${BUILD_GH_PAGES}/docs/${OPERATOR_VERSION} || true
+rm -rf ${BUILD_GH_PAGES}/docs/${OPERATOR_VERSION}/ || true
+cp -R ${BUILD_OUTPUT}/docs ${BUILD_GH_PAGES}/docs/${OPERATOR_VERSION}/
 rm -rf ${BUILD_GH_PAGES}/docs/latest
-cp -R ${BUILD_GH_PAGES}/docs/${VERSION} ${BUILD_GH_PAGES}/docs/latest
+cp -R ${BUILD_GH_PAGES}/docs/${OPERATOR_VERSION} ${BUILD_GH_PAGES}/docs/latest
 git add -A docs/*
 
 mkdir -p ${BUILD_GH_PAGES}/charts || true
-cp ${BUILD_OUTPUT}/helm-charts/coherence-operator-${VERSION}.tgz ${BUILD_GH_PAGES}/charts/
+cp ${BUILD_OUTPUT}/helm-charts/coherence-operator-${OPERATOR_VERSION}.tgz ${BUILD_GH_PAGES}/charts/
 helm repo index charts --url https://oracle.github.io/coherence-operator/charts
-git add charts/coherence-operator-${VERSION}.tgz
+git add charts/coherence-operator-${OPERATOR_VERSION}.tgz
 git add charts/index.yaml
 
 git clean -d -f
 
 git status
 
-git commit -m "Release Coherence Operator version: ${VERSION}"
+git commit -m "Release Coherence Operator version: ${OPERATOR_VERSION}"
 git log -1
 git push origin gh-pages
 
-cd ${ROOT_DIR}
+cd ${WORKSPACE}
diff --git a/hack/kind/kind-config.yaml b/hack/kind/kind-config.yaml
