Update docs to main

content/en/docs/_index.md

@@ -1,6 +1,6 @@
 ---
 title : "Docs"
-description: "Docs ArkMQ."
+description: "Docs Arkmq-org."
 lead: ""
 date: 2020-10-06T08:48:23+00:00
 lastmod: 2020-10-06T08:48:23+00:00

content/en/docs/getting-started/introduction.md

@@ -1,7 +1,7 @@
 ---
 title: Introduction
-description: ArkMQ is a collection of container images that provide a way to deploy the Apache ActiveMQ Artemis Broker on Kubernetes.
-lead: ArkMQ is a collection of container images that provide a way to deploy the Apache ActiveMQ Artemis Broker on Kubernetes.
+description: arkmq-org.io is a collection of container images that provide a way to deploy the Apache ActiveMQ Artemis Broker on Kubernetes.
+lead: arkmq-org.io is a collection of container images that provide a way to deploy the Apache ActiveMQ Artemis Broker on Kubernetes.
 date: 2020-10-06T08:48:57.000Z
 lastmod: 2020-10-06T08:48:57.000Z
 draft: false
@@ -13,19 +13,17 @@ toc: true
 
 ## Welcome
 
-Welcome to The ArkMQ documentation. This documentation is open source and can be found at [here](https://github.com/arkmq-org/activemq-artemis-operator/tree/main/docs). All contributions are welcome.
+Welcome to The arkmq-org documentation. This documentation is open source and can be found at [here](https://github.com/arkmq-org/activemq-artemis-operator/tree/main/docs). All contributions are welcome.
 
 ## Quick Start
 
-One page summary of how to start a new ArkMQ project. [Quick Start →]({{< relref "quick-start" >}})
+One page summary of how to start a new arkmq-org project. [Quick Start →]({{< relref "quick-start" >}})
 
 ## How to contribute to the docs
 
 You can contribute to these docs by sending a Pull Request to the [activemq-artemis-operator](https://github.com/arkmq-org/activemq-artemis-operator) Github repository.
 Each chapter is a single markdown file found under the [docs](https://github.com/arkmq-org/activemq-artemis-operator/tree/main/docs) directory.
-Simply update an existing chapter or add a new file for a new one. If you add a new on you should update the [\_index.md](https://github.com/arkmq-org/activemq-artemis-operator/blob/main/docs/_index.md)
-file with the new chapter .
 
 ## Help
 
-Get help on ArkMQ. [Help →]({{< relref "operator" >}})
+Get help on arkmq-org.io. [Help →]({{< relref "operator" >}})

content/en/docs/getting-started/quick-start.md

@@ -1,7 +1,7 @@
 ---
 title: "Quick Start"
-description: "One page summary of how to start a new ArkMQ project."
-lead: "One page summary of how to start a new ArkMQ project."
+description: "One page summary of how to start a new arkmq-org project."
+lead: "One page summary of how to start a new arkmq-org project."
 date: 2020-11-16T13:59:39+01:00
 lastmod: 2020-11-16T13:59:39+01:00
 draft: false
@@ -151,7 +151,9 @@ activemqartemis.broker.amq.io "artemis-broker" deleted
 
 Users can use the activemqartemisaddress CRD to create and remove queues/address on a running broker pod.
 
-For example suppose you have deployed a broker pod like above, you can deploy an activemqartemisaddress resouce from the [examples dir](../../examples/address/address_queue.yaml):
+Having [a deployed broker pod](#deploying-the-broker) is necessary to apply the commands in this section.
+
+Assuming you have one already running, you can then deploy an activemqartemisaddress resource from the [examples dir](../../examples/address/address_queue.yaml):
 
 address-queue.yaml:
 ```$yaml

content/en/docs/help/_index.md

@@ -1,6 +1,6 @@
 ---
 title: "Help"
-description: "Help ArkMQ."
+description: "Help Arkmq-org."
 lead: ""
 date: 2020-10-06T08:49:15+00:00
 lastmod: 2020-10-06T08:49:15+00:00

content/en/docs/help/building.md

@@ -1,7 +1,7 @@
 ---
 title: "Building"
-description: "Building ArkMQ"
-lead: "Building ArkMQ"
+description: "Building arkmq-org.io"
+lead: "Building arkmq-org.io"
 date: 2020-10-06T08:49:31+00:00
 lastmod: 2020-10-06T08:49:31+00:00
 draft: false
@@ -15,24 +15,19 @@ toc: true
 
 # Building the operator
 
-## General environment requirements
+## Prerequisites
 
-### A kubernetes cluster
+### Go
 
-Currently the operator is tested against kubernetes v1.25 and above.
-You can install a [Minikube](https://minikube.sigs.k8s.io/docs/) or a [CodeReady Containers(CRC)](https://developers.redhat.com/products/codeready-containers/overview) to deploy the operator.
+Download the Go version v1.21.11 from the [download page](https://go.dev/dl/) and install it following the [installation instructions](https://go.dev/doc/install).
 
-### Docker
-
-Current version being used is v23.0.3. Checkout [this page](https://docs.docker.com/get-docker/) for help on installing docker on your specific operating system.
+### Operator SDK
 
-### Go v1.19
+Install [Operator SDK](https://sdk.operatorframework.io/) version [v1.28.0](https://github.com/operator-framework/operator-sdk/releases/tag/v1.28.0) following the [installation instructions from a GitHub release](https://sdk.operatorframework.io/docs/installation/#install-from-github-release).
 
-Install Go version v1.19 following [this guide](https://go.dev/doc/install).
-
-### operator-sdk v1.28.0
+### Docker
 
-Install [operator-sdk](https://sdk.operatorframework.io/) following [this guide](https://sdk.operatorframework.io/docs/installation/).
+Install Docker following the [installation instructions](https://docs.docker.com/get-docker/).
 
 ## Get the code
 
@@ -86,4 +81,4 @@ or use the make target **docker-push**
 make OPERATOR_IMAGE_REPO=<your repo> OPERATOR_VERSION=<tag> docker-push
 ```
 
-Now follow the [quickstart]({{< ref "../getting-started/quick-start.md" >}}) to deploy the operator.
+Now follow the [quickstart](../getting-started/quick-start.md) to deploy the operator.

content/en/docs/help/bundle.md

@@ -1,7 +1,7 @@
 ---
 title: "Bundle"
-description: "Bundle ArkMQ"
-lead: "Bundle ArkMQ"
+description: "Bundle arkmq-org.io"
+lead: "Bundle arkmq-org.io"
 date: 2020-10-06T08:49:31+00:00
 lastmod: 2020-10-06T08:49:31+00:00
 draft: false
@@ -13,87 +13,43 @@ weight: 630
 toc: true
 ---
 
-# Bunding A Bundle and Deploy it into the Operator Lifecycle Manager(OLM)
+# Bundle
 
-## About the Operator Lifecycle Manager (OLM)
+## Operator Lifecycle Manager (OLM)
+The [Operator Lifecycle Manager](https://olm.operatorframework.io/) can help users to install and manage operators. The arkmq-org operator can be built into a bundle image and installed into OLM.
 
-The [Operator Lifecycle Manager](https://olm.operatorframework.io/) can help users to install and manage operators.
-The ArkMQ operator can be built into a bundle image and installed into OLM.
+### Install OLM
+Check out the latest [releases on github](https://github.com/operator-framework/operator-lifecycle-manager/releases) for release-specific install instructions.
 
-## Building
+## Create a repository
+Create a repository that Kubernetes will uses to pull your catalog image. You can create a public one for free on quay.io, see [how to create a repo](https://docs.quay.io/guides/create-repo.html).
 
-### Creating the bundle's manifests/metadata
-
-Before you build the bundle image generate the manifests and metadata:
-
-```$xslt
-make IMAGE_TAG_BASE=<bundle image registry> OPERATOR_IMAGE_REPO=<operator image registry> OPERATOR_VERSION=<operator tag> bundle
-```
-
-### Building the bundle image:
-
-```$xslt
-make IMAGE_TAG_BASE=<bundle image registry> bundle-build
-```
-The result image tag takes the form like
-```$xslt
-${IMAGE_TAG_BASE}-bundle:v0.0.1
+## Build a catalog image
+Set your repository in CATALOG_IMG and execute the following command:
 ```
-Note: the version v0.0.1 is defined by VERSION variable in the Makefile
-
-To push the built bundle image
-
-```$xslt
-make IMAGE_TAG_BASE=<bundle image registry> bundle-push
+make CATALOG_IMG=quay.io/my-org/activemq-artemis-operator-index:latest catalog-build
 ```
 
-### Building the catalog image
-
-Now with the bundle image in place, build the catalog(index) iamge:
-
-```$xslt
-make IMAGE_TAG_BASE=<bundle image registry> catalog-build
+## Push a catalog image
+Set your repository in CATALOG_IMG and execute the following command:
 ```
-The result image tag takes the form like
-```$xslt
-${IMAGE_TAG_BASE}-index:v0.0.1
+make CATALOG_IMG=quay.io/my-org/activemq-artemis-operator-index:latest catalog-push
 ```
 
-To push the catalog image to repo:
-
-```$xslt
-make IMAGE_TAG_BASE=<bundle image registry> catalog-push
-```
-
-## Installing operator via OLM (Minikube)
-
-### Install olm (If olm is not installed already)
-
-Make sure the Minikube is up and running.
-
-Use the [operator-sdk tool](https://sdk.operatorframework.io/):
-
-```$xslt
-operator-sdk olm install
-```
-It will deploy the latest olm into Minikube.
-
-### Create a catalog source (e.g. catalog-source.yaml):
+## Create a catalog source (e.g. catalog-source.yaml):
+Before creating the catalog source, ensure to update the **image** field within the `spec` section with your own built catalog image specified by the `CATALOG_IMG` environment variable.
+For the `CATALOG_IMG`, refer to the [Build a catalog image](#build-a-catalog-image) section.
 
 ```
 apiVersion: operators.coreos.com/v1alpha1
 kind: CatalogSource
 metadata:
-  name: artemis-index
+  name: activemq-artemis-operator-source
   namespace: operators
 spec:
+  displayName: ActiveMQ Artemis Operators
+  image: quay.io/my-org/activemq-artemis-operator-index:latest
   sourceType: grpc
-  image: quay.io/hgao/operator-catalog:v0.0.1
-  displayName: ArkMQ Index
-  publisher: ArkMQ
-  updateStrategy:
-    registryPoll:
-      interval: 10m
 ```
 
 and deploy it:
@@ -104,25 +60,24 @@ $ kubectl create -f catalog-source.yaml
 In a moment you will see the index image is up and running in namespace **operators**:
 
 ```$xslt
-[a]$ kubectl get pod -n operators
-NAME                  READY   STATUS    RESTARTS   AGE
-artemis-index-bzh75   1/1     Running   0          42s
+$ kubectl get pod -n operators
+NAME                                      READY   STATUS    RESTARTS   AGE
+activemq-artemis-operator-source-g94fd    1/1     Running   0          42s
 ```
 
-### Creating a subscription (e.g. subscription.yaml)
+## Create a subscription (e.g. subscription.yaml)
 
 ```
 apiVersion: operators.coreos.com/v1alpha1
 kind: Subscription
 metadata:
-  name: my-subscription
+  name: activemq-artemis-operator-subscription
   namespace: operators
 spec:
   channel: upstream
   name: activemq-artemis-operator
-  source: artemis-index
+  source: activemq-artemis-operator-source
   sourceNamespace: operators
-  installPlanApproval: Automatic
 ```
 
 and deploy it:
@@ -134,7 +89,23 @@ An operator will be installed into **operators** namespace.
 ```$xslt
 $ kubectl get pod -n operators
 NAME                                                              READY   STATUS      RESTARTS   AGE
-9365c56f188be1738a1fabddb5a408a693d8c1f2d7275514556644e52ejpdpj   0/1     Completed   0          2m20s
-activemq-artemis-controller-manager-84d58db649-tkt89              1/1     Running     0          117s
-artemis-index-frpn4                                               1/1     Running     0          3m35s
+069c5d363d51fc04d639086da1c5180883a6cea8ec9d9f9eedde1a55f6v7jsq   0/1     Completed   0          9m55s
+activemq-artemis-controller-manager-54c99b9df6-6xdzh              1/1     Running     0          9m28s
+activemq-artemis-operator-source-g94fd                            1/1     Running     0          58m
+```
+
+## Create a single ActiveMQ Artemis
+
+This step creates a single ActiveMQ Artemis broker instance by applying the custom resource (CR) defined in artemis_single.yaml file.
+
+```$xslt
+$ kubectl apply -f examples/artemis/artemis_single.yaml
 ```
+
+To check the status of the broker, run:
+
+```$xslt 
+$ kubectl get ActivemqArtemis 
+NAME             READY   AGE
+artemis-broker   True    39s
+```

content/en/docs/help/custom-resources.md

@@ -1,7 +1,7 @@
 ---
 title: "Custom Resources"
-description: "Custom Resource ArkMQ"
-lead: "Custom Resource ArkMQ"
+description: "Custom Resource arkmq-org.io"
+lead: "Custom Resource arkmq-org.io"
 date: 2020-10-06T08:49:31+00:00
 lastmod: 2020-10-06T08:49:31+00:00
 draft: false