Markdown Lint fixes

Author: jbrejner

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+  "MD013" :false ,
+  "MD033": {
+      "allowed_elements": ["details", "summary"]
+    }
+}

README.md

@@ -1,16 +1,15 @@
 # Argo CD Katas
 
-Welcome to the Argo CD Katas repository! This project is designed to help users learn and master Argo CD through practical exercises and challenges. 
+Welcome to the Argo CD Katas repository! This project is designed to help users learn and master Argo CD through practical exercises and challenges.
 
 Whether you are a beginner looking to understand the basics or an experienced user seeking to deepen your knowledge, these katas will guide you through various aspects of using Argo CD in a real-world context.
 
 ## About Argo CD
 
-Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes. 
+Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
 It allows for Kubernetes resources to be managed using git repositories as the source of truth, making it easier to implement continuous deployment strategies in cloud-native environments.
 For more info on ArgoCD itself, please visit [their website](https://argoproj.github.io/cd/).
 
-
 ## Exercise list in order
 
 It is recommended to follow the exercises in the following order.
@@ -51,8 +50,7 @@ The repository is structured as follows:
 └── trainer # Trainer folder
 ```
 
-
 ## Links
 
-* https://codefresh.io/blog/argo-cd-best-practices/
-* https://github.com/akuity/awesome-argo/blob/main/CONTRIBUTING.md
+* <https://codefresh.io/blog/argo-cd-best-practices/>
+* <https://github.com/akuity/awesome-argo/blob/main/CONTRIBUTING.md>

app-of-apps.md

@@ -23,13 +23,12 @@ In this exercise, we will work on organizing and managing Argo CD applications m
 <details>
 <summary>More Details</summary>
 
-* Create bootsrap app manifest
-* Create folder for all apps in the repo
-* Move Jenkins app manifest to the folder
-* Create the app manifest for the quotes helm chart located in the same repo. (OR IN THE OTHER REPO TODO)
-  * Enable sync policy, prune and self-heal
-* kubectl delete parent app, make sure nothing is there. kubectl apply parent app again. 
-
+- Create bootsrap app manifest
+- Create folder for all apps in the repo
+- Move Jenkins app manifest to the folder
+- Create the app manifest for the quotes helm chart located in the same repo. (OR IN THE OTHER REPO TODO)
+  - Enable sync policy, prune and self-heal
+- kubectl delete parent app, make sure nothing is there. kubectl apply parent app again.
 
 ## Step 1: Create Bootstrap App Manifest
 
@@ -69,7 +68,7 @@ kubectl apply -f bootstrap-app.yaml
 
 1. Go to the Argo CD UI and verify that the bootstrap app is present. It should have an error saying that it cannot find the `apps` folder. This is expected.
 
-## Step 2: Create Folder for All Apps, and add Jenkins App Manifest to it.
+## Step 2: Create Folder for All Apps, and add Jenkins App Manifest to it
 
 Save the current application manifest to your repository in a new folder named `apps`.
 
@@ -112,6 +111,7 @@ spec:
       prune: true
       selfHeal: true
 ```
+
 </details>
 
 - Add, commit and push the jenkins-app.yaml to the repository.
@@ -124,7 +124,6 @@ Now the jenkins app is connected with the bootstrap app.
 - In the Argo CD UI, delete the jenkins app.
 - What happens when you do that?
 
-
 ## Create the App Manifest for the Quotes Helm Chart
 
 1. In the `apps` folder, create a file named `quotes-app.yaml` with the following content:

applicationsets.md

@@ -31,32 +31,32 @@ Thus the ApplicationSet controller does not create/modify/delete Kubernetes reso
 
 #### Create a github token
 
-* Go to your github account settings and [create a new token](https://github.com/settings/tokens?type=beta) with the following permissions:
+- Go to your github account settings and [create a new token](https://github.com/settings/tokens?type=beta) with the following permissions:
 
 ![github token permissions](img/github-token-permissions.png)
 
-* Copy the token to your clipboard
+- Copy the token to your clipboard
 
 #### Add the token to a secret in the argocd namespace
 
-* Create a secret in the argocd namespace with the token
+- Create a secret in the argocd namespace with the token
 
 ```bash
 
 kubectl create secret generic --dry-run=client student-<NUMBER>-github-token -n argocd -o yaml --from-literal token=github_pat_yourtokenhere > secret.yaml
 
 ```
 
-* Edit the secret and replace `<NUMBER>` with your number (student-X)
+- Edit the secret and replace `<NUMBER>` with your number (student-X)
 
-* Apply the secret
+- Apply the secret
 
 ```bash
 kubectl apply -f secret.yaml
 
 ```
 
-* Check that the secret is there
+- Check that the secret is there
 
 ```bash
 
@@ -118,23 +118,24 @@ spec:
           prune: true
           selfHeal: true
 ```
-* take the contents of the file, and paste it into a file in your workstation. The file could be named ´appset.yaml´.
-* edit the file and replace
-    * `<YOUR GITHUB USERNAME>` with your github username
-    * `<YOUR GIT REPO>` with your git repo
-    * `<YOUR NAMESPACE>` with your namespace
-    * `<NUMBER>` with your number (student-X)
-    * `<YOUR PREFIX>` The first part before `eficode.academy` as `gitops.eficode.academy`
 
-* Apply the manifest
+- take the contents of the file, and paste it into a file in your workstation. The file could be named ´appset.yaml´.
+- edit the file and replace
+  - `<YOUR GITHUB USERNAME>` with your github username
+  - `<YOUR GIT REPO>` with your git repo
+  - `<YOUR NAMESPACE>` with your namespace
+  - `<NUMBER>` with your number (student-X)
+  - `<YOUR PREFIX>` The first part before `eficode.academy` as `gitops.eficode.academy`
+
+- Apply the manifest
 
 ```bash
 kubectl apply -f appset.yaml
 ```
 
-* Make sure that it is there by listing the applicationsets: `k get applicationsets.argoproj.io -n argocd`.
+- Make sure that it is there by listing the applicationsets: `k get applicationsets.argoproj.io -n argocd`.
 
-* Look at the status on it by `k describe applicationsets.argoproj.io -n argocd pr-X` where X is your number.
+- Look at the status on it by `k describe applicationsets.argoproj.io -n argocd pr-X` where X is your number.
 
 Output should look like the following:
 
@@ -207,41 +208,39 @@ Status:
 Events:                    <none>
 ```
 
-
 #### Test with a pull request
 
-* Create a pull request in your git repo. The change does not matter at this time, since we are not using the source code in the pull request. 💡 The name of your branch needs to have all lowercase characters, otherwise it will not work.
-
+- Create a pull request in your git repo. The change does not matter at this time, since we are not using the source code in the pull request. 💡 The name of your branch needs to have all lowercase characters, otherwise it will not work.
 
-* Remember to set the label `enhancement` on the pull request. The label does not exist, so create it in the Github UI.
+- Remember to set the label `enhancement` on the pull request. The label does not exist, so create it in the Github UI.
 
-* Check that an application has been created in ArgoCD
+- Check that an application has been created in ArgoCD
 
 ```bash
 kubectl get applications -n argocd
 ```
 
-* Check that an application has been created in your namespace
+- Check that an application has been created in your namespace
 
 ```bash
 kubectl get pods -n <YOUR NAMESPACE>
 ```
 
-* Get your ingress hostname
+- Get your ingress hostname
 
 ```bash
 kubectl get ingress -n <YOUR NAMESPACE>
 ```
 
-* Access the application in your browser (remember to add https:// in front of the hostname)
+- Access the application in your browser (remember to add https:// in front of the hostname)
 
 You should see something like the follwing:
 
 ![the todo application](img/todo-app.png)
 
 #### Close the pull request
 
-* now close the pull request, and see that the application is deleted from ArgoCD
+- now close the pull request, and see that the application is deleted from ArgoCD
 
 ```bash
 kubectl get applications -n argocd
@@ -251,15 +250,15 @@ kubectl get applications -n argocd
 
 ### Clean up
 
-* Delete the applicationset
+- Delete the applicationset
 
 ```bash
 kubectl delete -f applicationsets/pull-request.yaml
 ```
 
 #### Further reading
 
-* [ApplicationSet](https://argocd-applicationset.readthedocs.io/en/stable/)
-* [ApplicationSet Generators](https://argocd-applicationset.readthedocs.io/en/stable/Generators/)
-* [ApplicationSet Templates](https://argocd-applicationset.readthedocs.io/en/stable/Template/)
-* [ApplicationSet Pr example](https://dev.to/camptocamp-ops/using-argocd-pull-request-generator-to-review-application-modifications-236e)
+- [ApplicationSet](https://argocd-applicationset.readthedocs.io/en/stable/)
+- [ApplicationSet Generators](https://argocd-applicationset.readthedocs.io/en/stable/Generators/)
+- [ApplicationSet Templates](https://argocd-applicationset.readthedocs.io/en/stable/Template/)
+- [ApplicationSet Pr example](https://dev.to/camptocamp-ops/using-argocd-pull-request-generator-to-review-application-modifications-236e)

argocd-and-helm.md

@@ -14,7 +14,6 @@
 <summary>:bulb: Example</summary>
 
 ```yaml
-
 apiVersion: argoproj.io/v1alpha1
 kind: Application
 metadata:
@@ -55,8 +54,8 @@ spec:
       targetRevision: main
       # name this source "values" for reference in the above source.
       ref: values
-
 ```
+
 </details>
 
 ## Exercise
@@ -70,15 +69,15 @@ In this exercise, you will:
 - Write a multi-source deployment file.
 - Change the values in the deployment file for automatic changes to the Jenkins app.
 
-
 ### Step by Step Instructions
 
 <details>
 <summary>More Details</summary>
 
 ### Tasks
 
-**Deploying Jenkins with Bitnami Helm**
+#### Deploying Jenkins with Bitnami Helm
+
 - Look into the repository site (Click `settings`, and then `repositories`) to see that a repository called `bitnami` with the URL `https://charts.bitnami.com/bitnami` is there.
 - Click on `Applications` in the navigation bar.
 - Click on `New App` to create a new application.
@@ -87,7 +86,7 @@ In this exercise, you will:
   - **Project Name**: `default`
   - **Sync Policy**: `Automatic`
   - **Repository Type**: `Helm`
-  - **Repository URL**: https://charts.bitnami.com/bitnami (or select from the dropdown)
+  - **Repository URL**: <https://charts.bitnami.com/bitnami> (or select from the dropdown)
   - **Chart**: `Jenkins`
   - **Version**: `12.4.0`
   - **Cluster**: `in-cluster` or `https://kubernetes.default.svc`
@@ -106,7 +105,8 @@ Under the helm parameters, you can see that there are a lot of parameters that c
 - Find the http nodeport by clicking on the `studentx-jenkins` service.
 - Access the Jenkins site by going to `http://<node-ip>:<nodeport>`. You can find the external node IP by running `kubectl get nodes -o wide`.
 
-**Customizing the Jenkins deployment with a values file**
+#### Customizing the Jenkins deployment with a values file
+
 We will change the values of the Jenkins deployment by using a values file. This is useful when you want to keep your values in a separate file and not in the ArgoCD UI.
 
 - Look at the `values.yaml` file in the `jenkins` directory. You can see that the `service.type` is set to `NodePort`, and two other values.
@@ -131,6 +131,7 @@ sources:
     targetRevision: main
     ref: values
 ```
+
 💡 Remember to add your own repo to the file as well, as seen on the bottom. Pay attention to formatting.
 
 - Click save.
@@ -139,8 +140,6 @@ sources:
 
 > :bulb: It might also be that the application has a hard time syncing the new pod. You can try to delete the replica set and see if it works. If not, you can delete the application and try again.
 
-
 - Try to change something in the `values.yaml` file, push it up, and see that the application is synced automatically. If you lack inspiration, you can change the `service.type` to `ClusterIP` and see that the service is now a ClusterIP service.
 
 </details>
-

examples/folder-structures/README.md

@@ -1 +1 @@
-Different ways of organizing your applications in ArgoCD
+# Different ways of organizing your applications in ArgoCD

examples/folder-structures/folder-per-env-helm-enabled/README.md

@@ -2,10 +2,10 @@
 
 Only one values file per environment.
 
+## Pros
 
-# Pros
 - only display what the developer really needs to touch
 
+## Cons
 
-# Cons
-- blackbox for developers
+- blackbox for developers

examples/folder-structures/folder-per-env/README.md

@@ -3,10 +3,12 @@
 An app manifest and a values file per application in the environment.
 
 Pros:
+
 - Clear separation of environments
 - Easy to understand
 - Easy to get an overview of what is deployed where
-    - `tree . -L 2` gives a good overview
+  - `tree . -L 2` gives a good overview
 
 Cons:
-- Application manifests are "bleeding" into dev environment
+
+- Application manifests are "bleeding" into dev environment