Cleanup (#342)

cleanup

.github/workflows/pull_request.yaml

@@ -10,7 +10,7 @@ jobs:
     uses: stakater/.github/.github/workflows/pull_request_doc_qa.yaml@v0.0.108
     with:
       MD_CONFIG: .github/md_config.json
-      DOC_SRC: content
+      DOC_SRC: content README.md
       MD_LINT_CONFIG: .markdownlint.yaml
   build:
     uses: stakater/.github/.github/workflows/pull_request_container_build.yaml@v0.0.108

.markdownlint.yaml

@@ -1,8 +1,8 @@
-{
-  "MD007": { "indent": 4 },
-  "MD013": false,
-  "MD024": false,
-  "MD029": { "style": one },
-  "MD033": false,
-  "MD046": false,
-}
+MD007:
+  indent: 4
+MD013: false
+MD024: false
+MD029:
+  style: one
+MD033: false
+MD046: false

README.md

@@ -4,7 +4,7 @@ SAAP docs are built using [MkDocs](https://github.com/mkdocs/mkdocs) which is ba
 
 ## GitHub Actions
 
-This repository has Github action workflow which checks the quality of the documentation and builds the Dockerfile image on Pull Requests. On a push to the main branch, it will create a GitHub release and push the built Dockerfile image to an image repository.
+This repository has GitHub action workflow which checks the quality of the documentation and builds the Dockerfile image on Pull Requests. On a push to the main branch, it will create a GitHub release and push the built Dockerfile image to an image repository.
 
 ## Build locally
 
@@ -25,13 +25,13 @@ git submodule update --init --recursive --remote
 Build Dockerfile test image:
 
 ```bash
-$ docker build . -t test
+docker build . -t test
 ```
 
 Run test container:
 
 ```bash
-$ docker run -p 8080:8080 test
+docker run -p 8080:8080 test
 ```
 
 Then access the docs on [`localhost:8080/saap`](localhost:8080/saap).
@@ -45,55 +45,55 @@ Install [Python 3](https://www.python.org/downloads/).
 Install mkdocs-material and mermaid plugin:
 
 ```bash
-$ pip3 install mkdocs-material mkdocs-mermaid2-plugin
+pip3 install mkdocs-material mkdocs-mermaid2-plugin
 ```
 
 Install mkdocs-include-markdown-plugin (if not installed by default and gives an error):
 
 ```bash
-$ pip install mkdocs-include-markdown-plugin
+pip install mkdocs-include-markdown-plugin
 ```
 
-Finally, serve the docs using the built-in web server which is based on Python http server - note that the production build will use Nginx instead:
+Finally, serve the docs using the built-in web server which is based on Python http server - note that the production build will use `nginx` instead:
 
 ```bash
-$ mkdocs serve
+mkdocs serve
 ```
 
 or
 
 ```bash
-$ python3 -m mkdocs serve
+python3 -m mkdocs serve
 ```
 
 ### QA Checks
 
 Markdown linting:
 
 ```bash
-$ brew install markdownlint-cli
-$ markdownlint -c .markdownlint.yaml content
+brew install markdownlint-cli
+markdownlint -c .markdownlint.yaml content
 ```
 
 Spell checking:
 
 ```bash
-$ brew install vale
-$ vale content
+brew install vale
+vale content
 ```
 
 ## Use Tilt
 
 Install [Tilt](https://docs.tilt.dev/index.html), then run:
 
 ```bash
-$ tilt up
+tilt up
 ```
 
 Files `main.html` and `404.html` are served from `theme_common` rather than override since they are to be consistent throughout. If anything changes they can be served via `theme_override`.
 
-To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy and paste bash file using sudo cmd file to your root directory and then run the following cmd:
+To execute the prepare theme command after setup you need to add the `prepare_theme.sh` or copy and paste bash file using sudo command file to your root directory and then run the following command:
 
 ```bash
-$ chmod +x preparetheme sh
+chmod +x prepare_theme.sh
 ```

content/for-devops-engineers/how-to-guides/use-a-cluster-task-in-pipeline/use-a-clustertask-in-pipeline.md

@@ -37,7 +37,7 @@ Add a clusterTask to enhance Tekton pipeline.
           - defaultTaskName: git-clone
             params:
               - name: url
-                value: "git@github.com:stakater-ab/mto-console.git"
+                value: # path to MTO Console
             workspaces:
               - name: ssh-directory
                 workspace: ssh-directory
@@ -80,7 +80,7 @@ Add a clusterTask to enhance Tekton pipeline.
           - defaultTaskName: git-clone
             params:
               - name: url
-                value: "git@github.com:stakater-ab/mto-console.git"
+                value: # path to MTO Console
             workspaces:
               - name: ssh-directory
                 workspace: ssh-directory

content/managed-addons/argocd/for-administrators/installation.md

@@ -1,29 +1,17 @@
 # Installation
 
-ArgoCD is installed as part of GitOps Operator Dominator chart from `SAAP-addons` repository, along with other  managed-addons owned by Team Dominator.
+ArgoCD is installed as part of the SAAP addons.
 
 ## Installing OpenShift GitOps Operator Chart
 
-ArgoCD can be installed seamlessly in your Red Hat OpenShift environment through the Red Hat OpenShift GitOps Operator. This operator simplifies the installation process by providing a standardized way to manage GitOps tooling, including ArgoCD.
+ArgoCD will be installed seamlessly in your SAAP environment through the Red Hat OpenShift GitOps Operator. This operator simplifies the installation process by providing a standardized way to manage GitOps tooling, including ArgoCD.
 
-RedHat OpenShift GitOps Operator chart is available in [SAAP-addons repository](https://github.com/stakater-ab/SAAP-addons/tree/main/rh-OpenShift-GitOps-operator). By installing the Helm chart, you can quickly set up ArgoCD with default configurations and settings.
+During the installation process, a subscription will be created to install the GitOps Operator. This subscription ensures that you have access to the latest version of the operator and can receive updates and bug fixes seamlessly. The operator is responsible for managing the ArgoCD deployment and keeping it up to date.
 
-During the installation process, a subscription is created to install the GitOps Operator. This subscription ensures that you have access to the latest version of the operator and can receive updates and bug fixes seamlessly. The operator is responsible for managing the ArgoCD deployment and keeping it up to date.
-
-In addition to the operator, an operator group is also installed as part of the setup. The operator group is used to define the scope and target namespace for the operator, allowing for effective management and control over the ArgoCD deployment within your OpenShift environment.
-
-By leveraging the Red Hat OpenShift GitOps Operator, installing ArgoCD becomes a streamlined process. You can easily manage and update your ArgoCD deployment while benefiting from the rich ecosystem and support provided by Red Hat and the OpenShift platform.
+In addition to the operator, an operator group is also installed. The operator group is used to define the scope and target namespace for the operator, allowing for effective management and control over the ArgoCD deployment within your OpenShift environment.
 
 ## Installing OpenShift GitOps Instance Chart
 
-A second GitOps Operator Instance Helm chart, also available in [SAAP-addons repository](https://github.com/stakater-ab/SAAP-addons/tree/main/rh-OpenShift-GitOps-instance), installs the instance for GitOps Operator. This Helm chart enables you to customize the behavior of the operator according to your specific requirements.
-
-By installing the GitOps Operator Instance Helm chart, you create two essential Custom Resources: App Project and ArgoCD.
-
-The ArgoCD Custom Resource is particularly significant as it allows you to define various configurations for your ArgoCD instance. These configurations include the `ArgoCD-server`, which is responsible for the core functionality of ArgoCD. Additionally, you can define configurations for `Grafana` and `Prometheus`, enabling you to monitor the health and performance of your ArgoCD deployment.
-
-Furthermore, the ArgoCD Custom Resource allows you to define RBAC (Role-Based Access Control) configurations, ensuring that only authorized individuals have access to the ArgoCD instance. You can also configure the `repo-server`, which manages the synchronization of your application manifests stored in a version control repository.
-
-For high availability scenarios, the ArgoCD Custom Resource enables you to configure a `ha-server`, ensuring redundancy and fault tolerance. Finally, you can define configurations for the `controller`, which is responsible for orchestrating deployments and managing the lifecycle of your applications.
+A GitOps Operator Instance Helm chart installs the instance for GitOps Operator. This Helm chart enables you to customize the behavior of the operator according to your specific requirements.
 
-By utilizing the GitOps Operator Instance Helm chart and customizing the ArgoCD Custom Resource, you have fine-grained control over the configuration and behavior of your ArgoCD instance. This empowers you to tailor ArgoCD to meet your specific deployment needs and ensures a highly efficient and secure continuous deployment workflow.
+By using the GitOps Operator Instance Helm chart and customizing the ArgoCD Custom Resource, you have fine-grained control over the configuration and behavior of your ArgoCD instance. This empowers you to tailor ArgoCD to meet your specific deployment needs and ensures a highly efficient and secure continuous deployment workflow.