Add index to the topic for better visibility (#643)

tungbq · Jun 1, 2024 · 7c95d03 · 7c95d03
1 parent 0799f12
commit 7c95d03
Show file tree

Hide file tree

Showing 25 changed files with 168 additions and 147 deletions.
diff --git a/templates/TOPIC_TEMPLATE.md b/templates/TOPIC_TEMPLATE.md
@@ -2,7 +2,7 @@
 
 # YOUR_TOPIC
 
-## What is YOUR_TOPIC?
+## 1. What is YOUR_TOPIC?
 
 ### Overview
 
@@ -16,19 +16,19 @@
 
 - Provide a link to the official documentation for YOUR_TOPIC.
 
-## Prerequisites (Optional)
+## 2. Prerequisites (Optional)
 
 - Highlight any essential prerequisites necessary for understanding YOUR_TOPIC.
 - For instance, in the context of Kubernetes, prior knowledge of Docker might be required for comprehending containerization technology.
 
-## Installation
+## 3. Installation
 
 ### How to install YOUR_TOPIC?
 
 - Share installation steps or provide a link to detailed installation documentation.
 - Consider including instructions for both local and production environments.
 
-## Basics of YOUR_TOPIC
+## 4. Basics of YOUR_TOPIC
 
 ### Getting started with YOUR_TOPIC
 
@@ -37,7 +37,7 @@
 
 <!-- Direct users to official getting started documentation or offer a simple 'basic' example. -->
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Exploring Advanced Examples
 
@@ -46,7 +46,7 @@
 
 - Link to official advanced examples (if any)
 
-## More...
+## 6. More...
 
 ### Cheatsheet (Nice to have)
 

diff --git a/topics/ansible/README.md b/topics/ansible/README.md
@@ -1,4 +1,4 @@
-## What is Ansible
+## 1. What is Ansible
 
 ### Overview
 
@@ -14,13 +14,13 @@
 
 - Visit https://www.ansible.com/
 
-## Installation
+## 2. Installation
 
 ### How to install Ansible?
 
 - Follow this guide: https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#installing-ansible
 
-## Basics of Ansible
+## 3. Basics of Ansible
 
 ### Getting started with Ansible
 
@@ -30,13 +30,13 @@
 
 - Visit [ansible/basic/helloworld](./basic/helloworld/)
 
-## Beyond the Basics
+## 4. Beyond the Basics
 
 ### Exploring Advanced Examples
 
 - Checkout [advanced](./advanced/)
 
-## More
+## 5. More
 
 ### Ansible playbook cheatsheet
 

diff --git a/topics/architecture/README.md b/topics/architecture/README.md
@@ -1,14 +1,21 @@
 # Architecture Center
-## AWS Architecture Center
+
+## 1. AWS Architecture Center
+
 - Architecture Center: https://aws.amazon.com/architecture
 - AWS official youtube channel: [This is my architecture series](https://youtube.com/playlist?list=PLhr1KZpdzukdeX8mQ2qO73bg6UKQHYsHb&si=ztggdByRdqW9tKvl)
-## Azure Architecture Center
+
+## 2. Azure Architecture Center
+
 - Architecture Center: https://learn.microsoft.com/en-us/azure/architecture/
 - Browse Architecture Center: https://learn.microsoft.com/en-us/azure/architecture/browse/
 
-## Trunk Based Development
-A source-control branching model, where developers collaborate on code in a single branch called ‘trunk’ *, resist any pressure to create other long-lived development branches by employing documented techniques. They therefore avoid merge hell, do not break the build, and live happily ever after.
+## 3. Trunk Based Development
+
+A source-control branching model, where developers collaborate on code in a single branch called ‘trunk’ \*, resist any pressure to create other long-lived development branches by employing documented techniques. They therefore avoid merge hell, do not break the build, and live happily ever after.
+
 - https://trunkbaseddevelopment.com/
 
-## Deployment
+## 4. Deployment
+
 - Deployment Choice: Code Promotion vs Artifact Promotion: https://hackernoon.com/deployment-choice-code-promotion-vs-artifact-promotion
diff --git a/topics/argocd/README.md b/topics/argocd/README.md
@@ -1,4 +1,4 @@
-## What is ArgoCD?
+## 1. What is ArgoCD?
 
 - https://argo-cd.readthedocs.io/en/stable/#what-is-argo-cd
 
@@ -14,33 +14,33 @@ Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes.
 
 - Access the complete [official ArgoCD repo](https://github.com/argoproj/argo-cd) for detailed information and references.
 
-## Prerequisites
+## 2. Prerequisites
 
 - Familiarity with containerization concepts and basic Linux command-line usage would be beneficial for understanding ArgoCD.
 
-## Installation
+## 3. Installation
 
 ### How to install ArgoCD?
 
 - Follow the steps outlined in the [ArgoCD installation documentation](https://argo-cd.readthedocs.io/en/stable/operator-manual/installation/) for both local development and production environments.
 
-# Basics of ArgoCD
+## 4. Basics of ArgoCD
 
-### 1. Getting started with ArgoCD
+### Getting started with ArgoCD
 
 - Refer to the [official ArgoCD getting started documentation](https://argo-cd.readthedocs.io/en/stable/getting_started/) for a comprehensive introduction.
 
-### 2. ArgoCD Hello World
+### ArgoCD Hello World
 
 - Run the [basic/](./basic/install_argocd.sh) script to execute a simple ArgoCD "Hello World" demonstration.
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Hands-On Example
 
 - Explore a practical hands-on example in the [argocd-example-apps repo](https://github.com/argoproj/argocd-example-apps) to quickly start using ArgoCD.
 
-## More
+## 6. More
 
 ### ArgoCD Cheatsheet
 

diff --git a/topics/aws/README.md b/topics/aws/README.md
@@ -1,4 +1,4 @@
-## What is AWS?
+## 1. What is AWS?
 
 - https://aws.amazon.com/what-is-aws/
 
@@ -14,17 +14,17 @@ Amazon Web Services (AWS) is the world’s most comprehensive and broadly adopte
 
 - https://docs.aws.amazon.com/
 
-## Prerequisites
+## 2. Prerequisites
 
 - Familiarity with cloud concepts and basic Linux command-line usage would be beneficial for understanding AWS.
 
-## Installation
+## 3. Installation
 
 ### How to install AWS?
 
 - No need to install AWS, it's cloud environment
 
-## Basics of AWS
+## 4. Basics of AWS
 
 ### 1. Getting started with AWS
 
@@ -34,13 +34,13 @@ Amazon Web Services (AWS) is the world’s most comprehensive and broadly adopte
 
 - Check the [basic/](./basic/) directory to create a simple AWS EC2.
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Hands-On Example
 
 - Explore a practical hands-on example in the [AWS hands-on](https://aws.amazon.com/getting-started/hands-on) to quickly start using AWS.
 
-## More
+## 6. More
 
 ### AWS learning resource
 

diff --git a/topics/azuredevops/README.md b/topics/azuredevops/README.md
@@ -1,4 +1,4 @@
-## What is Azure DevOps?
+## 1. What is Azure DevOps?
 
 ### Overview
 
@@ -13,17 +13,17 @@ N/A
 
 - https://learn.microsoft.com/en-us/azure/devops
 
-## Prerequisites
+## 2. Prerequisites
 
 - Understanding the basic CICD concept would be helpful
 
-## Installation
+## 3. Installation
 
 ### How to install Azure DevOps?
 
 - No need to install, just use: https://dev.azure.com/
 
-## Basics of Azure DevOps
+## 4. Basics of Azure DevOps
 
 ### Azure DevOps quick start
 
@@ -33,13 +33,13 @@ N/A
 
 - Check the [basic/](./basic/) directory to create a simple Azure DevOps pipeline.
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Hands-On Example
 
 - Check the [advanced/](./advanced/) directory for more Azure DevOps examples.
 
-## More...
+## 6. More...
 
 ### Recommended Books
 

diff --git a/topics/coding/README.md b/topics/coding/README.md
@@ -1,8 +1,8 @@
 # Coding
 
-An important skill for DevOps
+Coding resources for DevOps
 
-## Some resource to level-up your coding skill and mindset
+## 1. Some resource to level-up your coding skill and mindset
 
 ### Design Pattern
 
@@ -14,4 +14,4 @@ An important skill for DevOps
 
 ### OOP Concepts
 
-- https://docs.oracle.com/javase/tutorial/java/concepts/
+- https://docs.oracle.com/javase/tutorial/java/concepts/
diff --git a/topics/docker/README.md b/topics/docker/README.md
@@ -1,4 +1,4 @@
-## What is Docker?
+## 1. What is Docker?
 
 ### Overview
 
@@ -12,37 +12,37 @@ For a deeper understanding, refer to the [Docker Architecture documentation](htt
 
 - Access the complete [official Docker documentation](https://docs.docker.com) for detailed information and references.
 
-## Prerequisites
+## 2. Prerequisites
 
 - Familiarity with containerization concepts and basic Linux command-line usage would be beneficial for understanding Docker.
 
-## Installation
+## 3. Installation
 
 ### How to install Docker?
 
 - Follow the steps outlined in the [Docker installation documentation](https://docs.docker.com/engine/install/) for both local development and production environments.
 
-## Basics of Docker
+## 4. Basics of Docker
 
-### 1. Getting started with Docker
+### Getting started with Docker
 
 - Refer to the [official Docker getting started documentation](https://docs.docker.com/get-started/) for a comprehensive introduction.
 
-### 2. Docker Hello World
+### Docker Hello World
 
 - Run the [basic/docker-helloworld.sh](./basic/docker-helloworld.sh) script to execute a simple Docker "Hello World" demonstration.
 
-### 3. Top Docker commands
+###Top Docker commands
 
 - Checkout [basic/top-docker-cmd.md](./basic/top-docker-cmd.md)
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Hands-On Example
 
 - Explore a practical hands-on example in the [advanced directory](./advanced/) to quickly start using Docker.
 
-## More
+## 6. More
 
 ### Docker Cheatsheet
 

diff --git a/topics/elk/README.md b/topics/elk/README.md
@@ -1,4 +1,4 @@
-## What is ELK?
+## 1. What is ELK?
 
 - https://www.elastic.co/what-is/elk-stack
 
@@ -15,33 +15,33 @@
 
 - https://www.elastic.co/guide/index.html
 
-## Prerequisites
+## 2. Prerequisites
 
 - None
 
-## Installation
+## 3. Installation
 
 ### How to install ELK?
 
 - Installing the Elastic Stack: https://www.elastic.co/guide/en/elastic-stack/current/installing-elastic-stack.html
 
-## Basics of ELK
+## 4. Basics of ELK
 
-### 1. Getting started with ELK
+### Getting started with ELK
 
 - Refer to the [Official ELK getting started documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/getting-started.html) for a comprehensive introduction.
 
-### 2. ELK Hello World
+### ELK Hello World
 
 - Check the [helloworld/](./basic/helloworld/) directory to create a simple ELK demo.
 
-## Beyond the Basics
+## 5. Beyond the Basics
 
 ### Hands-On Example
 
 - Explore a practical hands-on example in the [ELK hands-on](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more ELK concepts
 
-## More
+## 6. More
 
 ### ELK learning resource