Refactored target resources in gh-pages/docs (#146)

Author: amuraru

.github/workflows/ci-docs.yaml

@@ -23,13 +23,13 @@ jobs:
       - name: Set up Hugo
         uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0
         with:
-          hugo-version: '0.110.0'
+          hugo-version: 'latest'
           extended: true
 
       - name: Set up Node
         uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
-          node-version: 16
+          node-version: 20
 
       - name: Set up PostCSS
         run: npm install --save-dev autoprefixer postcss-cli postcss

.github/workflows/publish-docs.yaml

@@ -26,13 +26,13 @@ jobs:
       - name: Set up Hugo
         uses: peaceiris/actions-hugo@6e295a6a0c9087bf374299e9d67f9d2edab9f18f # v3.0.0
         with:
-          hugo-version: '0.110.0'
+          hugo-version: 'latest'
           extended: true
 
       - name: Set up Node
         uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
         with:
-          node-version: 16
+          node-version: 20
 
       - name: Set up PostCSS
         run: npm install --save-dev autoprefixer postcss-cli postcss

config/_default/config.toml

@@ -77,9 +77,9 @@ weight = 1
   url_latest_version = "/"
 
   # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
-  github_repo = "https://github.com/banzaicloud/koperator-docs"
+  github_repo = "https://github.com/adobe/koperator/tree/gh-pages"
   # An optional link to a related project repo. For example, the sibling repository where your product code lives.
-  github_project_repo = "https://github.com/banzaicloud/koperator"
+  github_project_repo = "https://github.com/adobe/koperator"
 
   # Specify a value here if your content directory is not in your repo's root directory
   # github_subdir = ""
@@ -114,7 +114,7 @@ weight = 1
   #  Set to true to disable breadcrumb navigation.
   breadcrumb_disable = false
   # Set to true to disable the About link in the site footer
-  footer_about_disable = false
+  footer_about_enable = true
   # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
   navbar_logo = true
   # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
@@ -130,39 +130,12 @@ weight = 1
   enable = true
 
   [params.links]
-  # End user relevant links. These will show up on left side of footer and in the community page if you have one.
-  #[[params.links.user]]
-  #  name = "Community forum"
-  #  url = "https://community.cisco.com/t5/application-networking-and/bd-p/dev-app-networking"
-  #  icon = "fa fa-envelope"
-  #  desc = "Discussion and help from your fellow users"
-  #[[params.links.user]]
-  #  name ="Twitter"
-  #  url = "https://twitter.com/ciscoemerge"
-  #  icon = "fab fa-twitter"
-  #  desc = "Follow us on Twitter to get the latest news!"
-  #[[params.links.user]]
-  #  name = "Linkedin"
-  #  url = "https://linkedin.com/cisco-emerging-technologies-and-incubation"
-  #  icon = "fab fa-linkedin"
-  #  desc = "Follow us on Twitter to get the latest news!"
-  # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
   [[params.links.developer]]
     name = "GitHub"
-    url = "https://github.com/banzaicloud/koperator"
+    url = "https://github.com/adobe/koperator"
     icon = "fab fa-github"
     desc = "Get involved with Koperator development"
-  [[params.links.developer]]
-    name = "Slack"
-    url = "https://outshift.slack.com"
-    icon = "fab fa-slack"
-    desc = "Chat with the project developers"
-  #[[params.links.developer]]
-  #  name = "Developer mailing list"
-  #  url = "https://example.org/mail"
-  #  icon = "fa fa-envelope"
-  #  desc = "Discuss development issues around the project"
-
+  
 ###############################################################################
 # Hugo - Top-level navigation (horizontal)
 ###############################################################################
@@ -171,22 +144,13 @@ weight = 1
     name = "Project page"
     weight = -110
     pre = "<i class='fab fa-github pr-2'></i>"
-    url = "https://github.com/banzaicloud/koperator"
-#  [[menu.main]]
-#    name = "Blog"
-#    weight = -120
-#    pre = "<i class='fas fa-blog pr-2'></i>"
-#    url = "https://github.com/bank-vaults/"
+    url = "https://github.com/adobe/koperator"
   [[menu.main]]
     name = "Documentation"
     weight = -100
     pre = "<i class='fas fa-book pr-2'></i>"
     url = "/docs/"
-  [[menu.main]]
-    name = "Community"
-    url = "https://outshift.slack.com"
-    pre = "<i class='fab fa-slack pr-2'></i>"
-    weight = 150
+
 
 ###############################################################################
 # Misc customizations
@@ -218,13 +182,9 @@ anchor = "smart"
   [security.funcs]
     getenv = ['^HUGO_', 'PWD', '^DOC_', 'ENVIRONMENT']
 
-[privacy]
-  [privacy.googleAnalytics]
-    respectDoNotTrack = true
-
 [module]
 proxy = "direct"
 [[module.imports]]
 path = "github.com/google/docsy"
 [[module.imports]]
-path = "github.com/google/docsy/dependencies"
+path = "github.com/google/docsy/dependencies"

config/production/config.toml

@@ -1,12 +1,7 @@
-baseurl = "https://banzaicloud.github.io/koperator-docs/"
+baseurl = "https://opensource.adobe.com/koperator/"
 buildDrafts = false
-#googleAnalytics = "G-FIXME"
+googleAnalytics = "G-FIXME"
 
-[services]
-[services.googleAnalytics]
-# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
-#id = "G-FIXME"
 
 [params]
-
-url_latest_version = "https://banzaicloud.github.io/koperator-docs/"
+url_latest_version = "https://opensource.adobe.com/koperator/"

content/_index.md

@@ -19,11 +19,9 @@ title: Koperator
 Read the Koperator documentation.
 {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/banzaicloud/koperator" %}}
-We do a [Pull Request](https://github.com/banzaicloud/koperator/pulls) contributions workflow on **GitHub**. New users and developers are always welcome!
+{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/adobe/koperator" %}}
+We do a [Pull Request](https://github.com/adobe/koperator/pulls) contributions workflow on **GitHub**. New users and developers are always welcome!
 {{% /blocks/feature %}}
 
-{{% blocks/feature icon="fa-brands fa-slack" title="Come chat with us!" url="https://outshift.slack.com/messages/koperator" url_text="Join Slack" %}}
-In case you need help, you can find us on <a href="https://outshift.slack.com/messages/koperator">Slack</a>.
-{{% /blocks/feature %}}
-{{< /blocks/section >}}
+{{< /blocks/section >}}
+

content/docs/benchmarks/_index.md

@@ -72,7 +72,7 @@ How to setup the environment for the Kafka Performance Test.
 1. Install the Koperator CustomResourceDefinition resources (adjust the version number to the Koperator release you want to install) and the corresponding version of Koperator, the Operator for managing Apache Kafka on Kubernetes.
 
     ```bash
-    kubectl create --validate=false -f https://github.com/banzaicloud/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml
+    kubectl create --validate=false -f https://github.com/adobe/koperator/releases/download/v{{< param "latest_version" >}}/kafka-operator.crds.yaml
     ```
 
     ```bash

content/docs/compatibility-matrix.md

@@ -10,16 +10,16 @@ This page shows you the list of supported Koperator versions, and the versions o
 
 |Operator Version|Apache Kafka Version|JMX Exporter Version|Cruise Control Version|Istio Operator Version|Example cluster CR|Maintained|
 |-------|------|----------------|-------|----|---|-|
-|v0.18.3|2.6.2+|0.15.0|2.5.37|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.18.3/config/samples/simplekafkacluster.yaml)|-|
-|v0.19.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.19.0/config/samples/simplekafkacluster.yaml)|-|
-|v0.20.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.20.0/config/samples/simplekafkacluster.yaml)|-|
-|v0.20.2|2.6.2+|0.16.1|2.5.80|1.10|[link](https://github.com/banzaicloud/koperator/blob/v0.20.2/config/samples/simplekafkacluster.yaml)|-|
-|v0.21.0|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.0/config/samples/simplekafkacluster.yaml)|-|
-|v0.21.1|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.1/config/samples/simplekafkacluster.yaml)|-|
-|v0.21.2|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/banzaicloud/koperator/blob/v0.21.2/config/samples/simplekafkacluster.yaml)|-|
-|v0.22.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.22.0/config/samples/simplekafkacluster.yaml)|+|
-|v0.23.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.23.0/config/samples/simplekafkacluster.yaml)|+|
-|v0.24.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/banzaicloud/koperator/blob/v0.24.0/config/samples/simplekafkacluster.yaml)|+|
+|v0.18.3|2.6.2+|0.15.0|2.5.37|1.10|[link](https://github.com/adobe/koperator/blob/v0.18.3/config/samples/simplekafkacluster.yaml)|-|
+|v0.19.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.19.0/config/samples/simplekafkacluster.yaml)|-|
+|v0.20.0|2.6.2+|0.15.0|2.5.68|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.0/config/samples/simplekafkacluster.yaml)|-|
+|v0.20.2|2.6.2+|0.16.1|2.5.80|1.10|[link](https://github.com/adobe/koperator/blob/v0.20.2/config/samples/simplekafkacluster.yaml)|-|
+|v0.21.0|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.0/config/samples/simplekafkacluster.yaml)|-|
+|v0.21.1|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.1/config/samples/simplekafkacluster.yaml)|-|
+|v0.21.2|2.6.2+|0.16.1|2.5.86|2.11|[link](https://github.com/adobe/koperator/blob/v0.21.2/config/samples/simplekafkacluster.yaml)|-|
+|v0.22.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.22.0/config/samples/simplekafkacluster.yaml)|+|
+|v0.23.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.23.0/config/samples/simplekafkacluster.yaml)|+|
+|v0.24.0|2.6.2+|0.16.1|2.5.101|2.15.3|[link](https://github.com/adobe/koperator/blob/v0.24.0/config/samples/simplekafkacluster.yaml)|+|
 
 ## Available Koperator images
 

content/docs/configurations/crd/_index.md

@@ -5,4 +5,4 @@ weight: 990
 
 The following sections contain the reference documentation of the various custom resource definitions (CRDs) that are specific to Koperator.
 
-For sample YAML files, see the [samples directory in the GitHub project](https://github.com/banzaicloud/koperator/tree/master/config/samples).
+For sample YAML files, see the [samples directory in the GitHub project](https://github.com/adobe/koperator/tree/master/config/samples).

content/docs/configurations/examples/_index.md

@@ -11,52 +11,52 @@ You can use these examples as a base for your own Kafka cluster.
 
 This is our most descriptive KafkaCluster CR. You can find a lot of valuable explanation about the settings.
 
-- [Detailed CR with descriptions](https://github.com/banzaicloud/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml)
+- [Detailed CR with descriptions](https://github.com/adobe/koperator/blob/master/config/samples/banzaicloud_v1beta1_kafkacluster.yaml)
 
 ## Kafka cluster with monitoring
 
 This is a very simple KafkaCluster CR with Prometheus monitoring enabled.
 
-- [Simple KafkaCluster with monitoring](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster.yaml)
+- [Simple KafkaCluster with monitoring](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster.yaml)
 
 ## Kafka cluster with ACL, SSL, and rack awareness
 
 You can read more details about rack awareness [here]({{< relref "../../rackawareness/index.md" >}}).
 
-- [Use SSL and rack awareness](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups.yaml)
+- [Use SSL and rack awareness](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups.yaml)
 
 ## Kafka cluster with broker configuration
 
-- [Use broker configuration groups](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_without_ssl_groups.yaml)
-- [Use independent broker configurations](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_without_ssl.yaml)
+- [Use broker configuration groups](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_without_ssl_groups.yaml)
+- [Use independent broker configurations](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_without_ssl.yaml)
 
 ## Kafka cluster with custom SSL certificates for external listeners
 
 You can specify custom SSL certificates for listeners.  
 For details about SSL configuration, see {{% xref "../../ssl.md" %}}.
 
-- [Use custom SSL certificate for an external listener](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_external_ssl_customcert.yaml)
-- [Use custom SSL certificate for controller and inter-broker communication](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml). In this case you also need to provide the client SSL certificate for Koperator.  
-- [Hybrid solution](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml): some listeners have custom SSL certificates and some use certificates Koperator has generated automatically using cert-manager.
+- [Use custom SSL certificate for an external listener](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_external_ssl_customcert.yaml)
+- [Use custom SSL certificate for controller and inter-broker communication](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_groups_customcert.yaml). In this case you also need to provide the client SSL certificate for Koperator.  
+- [Hybrid solution](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster_with_ssl_hybrid_customcert.yaml): some listeners have custom SSL certificates and some use certificates Koperator has generated automatically using cert-manager.
 
 ## Kafka cluster with SASL
 
 You can use SASL authentication on the listeners.
 For details, see {{% xref "../../external-listener/index.md" %}}.
 
-- [Use SASL authentication on the listeners](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_with_sasl.yaml)
+- [Use SASL authentication on the listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_with_sasl.yaml)
 
 ## Kafka cluster with load balancers and brokers in the same availability zone
 
 You can create a broker-ingress mapping to eliminate traffic across availability zones between load balancers and brokers by configuring load balancers for brokers in same availability zone.
 
-- [Load balancers and brokers in same availability zone](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster-with-brokerbindings.yaml)
+- [Load balancers and brokers in same availability zone](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-brokerbindings.yaml)
 
 ## Kafka cluster with Istio
 
 You can use Istio as the ingress controller for your external listeners. It requires using our [Istio operator](https://github.com/banzaicloud/istio-operator) in the Kubernetes cluster.  
 
-- [Kafka cluster with Istio as ingress controller](https://github.com/banzaicloud/koperator/blob/master/config/samples/kafkacluster-with-istio.yaml)
+- [Kafka cluster with Istio as ingress controller](https://github.com/adobe/koperator/blob/master/config/samples/kafkacluster-with-istio.yaml)
 
 ## Kafka cluster with custom advertised address for external listeners and brokers
 
@@ -65,16 +65,16 @@ This is useful when you're advertising the brokers on an IP address different fr
 You can also set custom advertised address for external listeners.  
 For details, see {{% xref "../../external-listener/index.md" %}}.
 
-- [Custom advertised address for external listeners](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster-with-nodeport-external.yaml)
+- [Custom advertised address for external listeners](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster-with-nodeport-external.yaml)
 
 ## Kafka cluster with Kubernetes scheduler affinity settings
 
 You can set node [affinity](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/) for your brokers.
 
-- [Custom affinity settings](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_affinity.yaml)
+- [Custom affinity settings](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_affinity.yaml)
 
 ## Kafka cluster with custom storage class
 
 You can configure your brokers to use custom [storage classes](https://kubernetes.io/docs/concepts/storage/storage-classes/).
 
-- [Custom storage class](https://github.com/banzaicloud/koperator/blob/master/config/samples/simplekafkacluster_ebs_csi.yaml)
+- [Custom storage class](https://github.com/adobe/koperator/blob/master/config/samples/simplekafkacluster_ebs_csi.yaml)

content/docs/cruisecontroloperation.md

@@ -163,7 +163,7 @@ status:
 - The `state` shows the progress of the request.  
 - The `summary` is Cruise Control's optimization proposal. It shows the scope of the changes that Cruise Control will apply through the operation.  
 - The `retryCount` field shows the number of retries when a task has failed and `cruiseControlOperation.spec.errorPolicy` is set to `retry`. In this case, the `status.failedTask` field shows the history of the failed tasks (including their error messages).  
-For further information on the fields, see the [source code](https://github.com/banzaicloud/koperator/blob/master/api/v1alpha1/cruisecontroloperation_types.go).
+For further information on the fields, see the [source code](https://github.com/adobe/koperator/blob/master/api/v1alpha1/cruisecontroloperation_types.go).
 
 ## Control the created CruiseControlOperation {#control-cruisecontroloperation}