From 7c95d034036414484c7dfe9369565aff045bd719 Mon Sep 17 00:00:00 2001 From: Tung Leo Date: Sat, 1 Jun 2024 19:11:51 +0700 Subject: [PATCH] Add index to the topic for better visibility (#643) --- templates/TOPIC_TEMPLATE.md | 12 ++++++------ topics/ansible/README.md | 10 +++++----- topics/architecture/README.md | 17 ++++++++++++----- topics/argocd/README.md | 16 ++++++++-------- topics/aws/README.md | 12 ++++++------ topics/azuredevops/README.md | 12 ++++++------ topics/coding/README.md | 6 +++--- topics/docker/README.md | 18 +++++++++--------- topics/elk/README.md | 16 ++++++++-------- topics/git/README.md | 12 ++++++------ topics/github-action/README.md | 12 ++++++------ topics/gitlabci/README.md | 12 ++++++------ topics/groovy/README.md | 12 ++++++------ topics/helm/README.md | 13 +++++++------ topics/istio/README.md | 13 ++++++++----- topics/jenkins/README.md | 12 ++++++------ topics/k8s/README.md | 14 ++++++++------ topics/microservices/README.md | 13 +++++++++---- topics/nginx/README.md | 12 ++++++------ topics/openstack/README.md | 18 +++++++++--------- topics/prometheus/README.md | 12 ++++++------ topics/python/README.md | 12 ++++++------ topics/shell/README.md | 12 ++++++------ topics/sql/README.md | 5 ++++- topics/terraform/README.md | 12 ++++++------ 25 files changed, 168 insertions(+), 147 deletions(-) diff --git a/templates/TOPIC_TEMPLATE.md b/templates/TOPIC_TEMPLATE.md index 7650b72..38519ec 100644 --- 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 @@ -## 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 index 0172a94..87f13ce 100644 --- 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 index 0df2674..9f2c588 100644 --- 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 index fc0a2c0..be382cc 100644 --- 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 index 0022a12..0b176b1 100644 --- 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 index f486f3b..9ac5e9b 100644 --- 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 index 98d7e84..42e658c 100644 --- 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/ \ No newline at end of file +- https://docs.oracle.com/javase/tutorial/java/concepts/ diff --git a/topics/docker/README.md b/topics/docker/README.md index 07ba1d2..8ed1110 100644 --- 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 index e9f12ad..7a98350 100644 --- 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 diff --git a/topics/git/README.md b/topics/git/README.md index c355597..14d939a 100644 --- a/topics/git/README.md +++ b/topics/git/README.md @@ -1,4 +1,4 @@ -## What is Git? +## 1. What is Git? - https://git-scm.com/book/en/v2/Getting-Started-What-is-Git%3F @@ -15,17 +15,17 @@ Git is a free and open source distributed version control system designed to han - https://git-scm.com/ - https://github.com/git-guides -## Prerequisites +## 2. Prerequisites - Basic linux command line skill -## Installation +## 3. Installation ### How to install Git? - https://github.com/git-guides/install-git -## Basics of Git +## 4. Basics of Git ### Getting started with Git @@ -35,13 +35,13 @@ Git is a free and open source distributed version control system designed to han - Check the [helloworld/](./basic/hello-world/) directory to create a simple Git demo. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Explore a practical hands-on example in the [Git hands-on](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more Git concepts -## More +## 6. More ### Git guides page diff --git a/topics/github-action/README.md b/topics/github-action/README.md index b2b7b82..29f29fa 100644 --- a/topics/github-action/README.md +++ b/topics/github-action/README.md @@ -1,4 +1,4 @@ -## What is GitHub Action? +## 1. What is GitHub Action? - https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions @@ -14,17 +14,17 @@ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platf - https://docs.github.com/en/enterprise-cloud@latest/actions -## Prerequisites +## 2. Prerequisites - Basic linux command line skill, CICD, YAML -## Installation +## 3. Installation ### How to install GitHub Action? - No need to install, it's built along with GitHub server -## Basics of GitHub Action +## 4. Basics of GitHub Action ### Getting started with GitHub Action @@ -34,13 +34,13 @@ GitHub Actions is a continuous integration and continuous delivery (CI/CD) platf - Check the [basic/](./basic/) directory to create a simple GitHub Action demo. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Explore a practical hands-on example in the [learn-github-actions](https://docs.github.com/en/enterprise-cloud@latest/actions/learn-github-actions) for more GitHub Action concepts -## More... +## 6. More... ### Awesome GitHub workflow diff --git a/topics/gitlabci/README.md b/topics/gitlabci/README.md index 3b9f95e..63df085 100644 --- a/topics/gitlabci/README.md +++ b/topics/gitlabci/README.md @@ -1,4 +1,4 @@ -## What is Gitlab CI? +## 1. What is Gitlab CI? ### Overview @@ -12,11 +12,11 @@ GitLab CI/CD is a software development tool that allows organizations to impleme - https://docs.gitlab.com/ (CI/CD page) -## Prerequisites +## 2. Prerequisites - Basic linux command line skill, CICD, YAML -## Installation +## 3. Installation ### How to install Gitlab CI? @@ -28,7 +28,7 @@ GitLab CI/CD is a software development tool that allows organizations to impleme - https://docs.gitlab.com/ee/install/install_methods.html -## Basics of Gitlab CI +## 4. Basics of Gitlab CI ### Getting started with Gitlab CI @@ -38,14 +38,14 @@ GitLab CI/CD is a software development tool that allows organizations to impleme - Check the [basic/](./basic/) directory to create a simple Gitlab CI demo. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Explore a practical hands-on example in the [Gitlab CI examples](https://docs.gitlab.com/ee/ci/examples/) for more Gitlab CI concepts - Check the [advanced/](./advanced//) for more Gitlab CI concepts -## More... +## 6. More... ### Gitlab CI YAML syntax reference diff --git a/topics/groovy/README.md b/topics/groovy/README.md index 72eadc4..12792bb 100644 --- a/topics/groovy/README.md +++ b/topics/groovy/README.md @@ -1,4 +1,4 @@ -## What is Groovy? +## 1. What is Groovy? ### Overview @@ -13,30 +13,30 @@ - https://groovy-lang.org/documentation.html -## Prerequisites +## 2. Prerequisites - None -## Installation +## 3. Installation ### How to install Groovy? - See https://groovy-lang.org/install.html (I prefer using SDK man) - Facing missing java issue while installing: Visit: [groovy-with-sdk-missing-java.md](.././../troubleshooting/installation/groovy-with-sdk-missing-java.md) -## Basics of Groovy +## 4. Basics of Groovy ### Groovy Hello World - Check the [basic/](./basic/) directory to create a simple Groovy demo. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - TODO -## More... +## 6. More... ### Groovy extra resources diff --git a/topics/helm/README.md b/topics/helm/README.md index e2b72f5..c9725c8 100644 --- a/topics/helm/README.md +++ b/topics/helm/README.md @@ -1,27 +1,28 @@ -## What is Helm? +## 1. What is Helm? ### Overview - Helm is the package manager for Kubernetes ### Helm workflow + ![helm_workflow](https://v2.helm.sh/img/chart-illustration.png) ### Official website documentation of Helm - https://helm.sh/docs/ -## Prerequisites +## 2. Prerequisites - K8s, docker, linux -## Installation +## 3. Installation ### How to install Helm? - https://helm.sh/docs/intro/install/ -## Basics of Helm +## 4. Basics of Helm ### Helm quick start @@ -31,13 +32,13 @@ - Check the [basic/](./basic/) directory to create a simple Helm demo. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Check the [advanced/](./advanced/) directory for more Helm examples. -## More... +## 6. More... ### Helm cheatsheet diff --git a/topics/istio/README.md b/topics/istio/README.md index ae9e8c9..73dfbb2 100644 --- a/topics/istio/README.md +++ b/topics/istio/README.md @@ -1,6 +1,7 @@ -## What is Istio? +## 1. What is Istio? ### What is a Service Mesh? + - A service mesh is a dedicated infrastructure layer that you can add to your applications. It allows you to transparently add capabilities like observability, traffic management, and security, without adding them to your own code - Source: [what-is-a-service-mesh](https://istio.io/latest/about/service-mesh/#what-is-a-service-mesh) @@ -19,35 +20,37 @@ - Visit https://istio.io/latest/ -## Installation +## 2. Installation ### How to install Istio? - https://istio.io/latest/docs/setup/install/ -## Basics of Istio +## 3. Basics of Istio ### Getting started with Istio - https://istio.io/latest/docs/setup/getting-started/ -## Beyond the Basics +## 4. Beyond the Basics ### Exploring Advanced Examples - TODO -## More... +## 5. More... ### Istio cheatsheet - https://istio.io/latest/docs/reference/commands/ ### Istio with Azure + - https://github.com/Azure-Samples/aks-istio-addon-bicep - https://learn.microsoft.com/en-us/azure/aks/istio-about ### Google Cloud Platform Istio Demo + - [service-mesh-istio](https://github.com/GoogleCloudPlatform/microservices-demo/blob/main/kustomize/components/service-mesh-istio/README.md) ### Recommended Books diff --git a/topics/jenkins/README.md b/topics/jenkins/README.md index b089426..692201e 100644 --- a/topics/jenkins/README.md +++ b/topics/jenkins/README.md @@ -1,4 +1,4 @@ -## What is Jenkins? +## 1. What is Jenkins? ### Overview @@ -12,11 +12,11 @@ - https://www.jenkins.io/doc/ -## Prerequisites +## 2. Prerequisites - K8s, docker, linux -## Installation +## 3. Installation ### How to install Jenkins? @@ -26,7 +26,7 @@ - See [deploy-jenkins/README.md](../Jenkins/basic/deploy-jenkins/README.md) -## Basics of Jenkins +## 4. Basics of Jenkins ### Jenkins getting started @@ -36,13 +36,13 @@ - See: [Jenkins Hello world](./basic/Jenkins-Hello-World.md) -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Check the [advanced/](./advanced/) directory for more Jenkins examples. -## More... +## 6. More... ### Jenkins cheatsheet diff --git a/topics/k8s/README.md b/topics/k8s/README.md index 8fb2b4f..d1a0d1a 100644 --- a/topics/k8s/README.md +++ b/topics/k8s/README.md @@ -1,4 +1,4 @@ -## What is Kubernetes +## 1. What is Kubernetes ### Overview @@ -13,7 +13,7 @@ - Visit https://kubernetes.io/ -## Installation +## 2. Installation ### How to install Kubernetes? @@ -23,11 +23,11 @@ - Deploy a Production Ready Kubernetes Cluster: https://github.com/kubernetes-sigs/kubespray ### K8s cluster setup tool + - [kubeadm](https://kubernetes.io/docs/setup/production-environment/tools/kubeadm/) - [kOps](https://kops.sigs.k8s.io/) - -## Basics of Kubernetes +## 3. Basics of Kubernetes ### Getting started with Kubernetes @@ -39,19 +39,21 @@ - Run [k8s-helloworld.sh](./basic/helloworld/k8s-helloworld.sh) - Cleanup [k8s-helloworld-cleanup.sh](./basic/helloworld/k8s-helloworld-cleanup.sh) after demo comple -## Beyond the Basics +## 4. Beyond the Basics ### Exploring Advanced Examples - Checkout [advanced](./advanced/) ### kube101 labs + - Visit: https://ibm.github.io/kube101/ ### K8sHub + - Visit: https://github.com/tungbq/K8sHub -## More +## 5. More ### Kubernetes cheatsheet diff --git a/topics/microservices/README.md b/topics/microservices/README.md index bf7ba08..549b2a9 100644 --- a/topics/microservices/README.md +++ b/topics/microservices/README.md @@ -1,15 +1,20 @@ # Docs + - https://www.nginx.com/blog/deploying-microservices/ -## Microservices Demo +## 1. Microservices Demo + - Check out [GoogleCloudPlatform/microservices-demo](https://github.com/GoogleCloudPlatform/microservices-demo) - Also check out [Azure-Samples/aks-store-demo](https://github.com/Azure-Samples/aks-store-demo/tree/main) -## Microservices architecture design (by Azure) +## 2. Microservices architecture design (by Azure) + - Microservices architecture design: https://learn.microsoft.com/en-us/azure/architecture/microservices/ - aks-microservices: [aks-microservices](https://learn.microsoft.com/en-us/azure/architecture/reference-architectures/containers/aks-microservices/aks-microservices) - https://dotnet.microsoft.com/en-us/learn/aspnet/microservices-architecture -## Hands-on +## 3. Hands-on + ### Basics -- Checkout [basic](./basic/) content \ No newline at end of file + +- Checkout [basic](./basic/) content diff --git a/topics/nginx/README.md b/topics/nginx/README.md index 6eba2b7..4913981 100644 --- a/topics/nginx/README.md +++ b/topics/nginx/README.md @@ -1,4 +1,4 @@ -## What is Nginx? +## 1. What is Nginx? ### Overview @@ -12,11 +12,11 @@ - https://nginx.org/ -## Prerequisites +## 2. Prerequisites - Basic networking, HTTP, Linux -## Installation +## 3. Installation ### How to install Nginx? @@ -26,7 +26,7 @@ - TODO -## Basics of Nginx +## 4. Basics of Nginx ### Nginx getting started @@ -36,13 +36,13 @@ - See: [TODO](./basic/hello-nginx.sh) -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Check the [advanced/](./advanced/) directory for more Nginx examples. -## More... +## 6. More... ### Admin guide diff --git a/topics/openstack/README.md b/topics/openstack/README.md index d94c91a..d1045c2 100644 --- a/topics/openstack/README.md +++ b/topics/openstack/README.md @@ -1,4 +1,4 @@ -## What is Openstack? +## 1. What is Openstack? ### Overview @@ -12,34 +12,34 @@ For a deeper understanding, refer to the [Openstack Architecture documentation]( - Access the complete [Official Openstack documentation](https://docs.openstack.org/2023.2/) for detailed information and references. -## Prerequisites +## 2. Prerequisites -- TODO +- OS/Linux and Cloud concepts -## Installation +## 3. Installation ### How to install Openstack? - Follow the steps outlined in the [Openstack installation documentation](https://docs.openstack.org/2023.2/install/) for both local development and production environments. - Or use the installation script in [basic](./basic/) -## Basics of Openstack +## 4. Basics of Openstack -### 1. Getting started with Openstack +### Getting started with Openstack - Refer to the [official Openstack getting started documentation](https://docs.openstack.org/install-guide/get-started-with-openstack.html) for a comprehensive introduction. -### 2. Openstack Hello World +### Openstack Hello World - Run the [basic/openstack-helm.sh](./basic/openstack-helm.sh) script to execute a simple Openstack "Hello World" demonstration. -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - TODO -## More +## 6. More ### Openstack Cheatsheet diff --git a/topics/prometheus/README.md b/topics/prometheus/README.md index 9628148..fc135a3 100644 --- a/topics/prometheus/README.md +++ b/topics/prometheus/README.md @@ -1,4 +1,4 @@ -## What is Prometheus? +## 1. What is Prometheus? - https://prometheus.io/docs/introduction/overview/#what-is-prometheus @@ -16,17 +16,17 @@ - https://prometheus.io/docs/introduction/overview/ -## Prerequisites +## 2. Prerequisites - Linux, Helm, k8s -## Installation +## 3. Installation ### How to install Prometheus? - https://prometheus.io/docs/prometheus/latest/installation/ -## Basics of Prometheus +## 4. Basics of Prometheus ### Prometheus getting started @@ -38,13 +38,13 @@ - Run the demo scipt: `cd basic; ./prometheus-helloworld.sh` - (Optional) Run the demo scipt and cleanup right after the demo: `cd basic; ./prometheus-helloworld.sh true` -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Check the [advanced/](./advanced/) directory for more Prometheus examples. -## More... +## 6. More... ### Prometheus cheatsheet diff --git a/topics/python/README.md b/topics/python/README.md index e26700d..ea84fb3 100644 --- a/topics/python/README.md +++ b/topics/python/README.md @@ -1,4 +1,4 @@ -## What is Python? +## 1. What is Python? ### Overview @@ -13,18 +13,18 @@ - https://www.python.org/doc/ -## Prerequisites +## 2. Prerequisites - None -## Installation +## 3. Installation ### How to install Python? - Visit the Python Downloads Page to access the latest version of Python suitable for your operating system. - https://www.python.org/downloads/ -## Basics of Python +## 4. Basics of Python ### Python getting started @@ -36,13 +36,13 @@ - Explore the [helloworld.py](./basic/helloworld.py) file in the helloworld directory to get a basic introduction to running a Python script. - Run `cd helloworld; python3 helloworld.py` -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Find more examples at [advanced](./advanced/) -## More... +## 6. More... ### Python cheatsheet diff --git a/topics/shell/README.md b/topics/shell/README.md index ad223e8..e7992a2 100644 --- a/topics/shell/README.md +++ b/topics/shell/README.md @@ -1,4 +1,4 @@ -## What is Shell? +## 1. What is Shell? ### Overview @@ -13,17 +13,17 @@ - https://en.wikipedia.org/wiki/Shell_script -## Prerequisites +## 2. Prerequisites - K8s, docker, linux -## Installation +## 3. Installation ### How to install Shell? - Just install Linux then you would have shell enviroment as well -## Basics of Shell +## 4. Basics of Shell ### Shell getting started @@ -33,13 +33,13 @@ - See: [basic](./basic/) -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - Do more practice execises at [advanced](./advanced/) -## More... +## 6. More... ### Shell cheatsheet diff --git a/topics/sql/README.md b/topics/sql/README.md index e999986..5dfa151 100644 --- a/topics/sql/README.md +++ b/topics/sql/README.md @@ -1,4 +1,7 @@ # What is SQL? -# Where to learn? +- TODO + +## 1. Where to learn? + - [CS50x 2023 - Lecture 7 - SQL](https://www.youtube.com/live/zrCLRC3Ci1c?si=yCsB6cSRY5FqyOXd) diff --git a/topics/terraform/README.md b/topics/terraform/README.md index b55c98c..c790816 100644 --- a/topics/terraform/README.md +++ b/topics/terraform/README.md @@ -1,4 +1,4 @@ -## What is Terraform? +## 1. What is Terraform? - https://developer.hashicorp.com/terraform/intro @@ -15,18 +15,18 @@ - https://developer.hashicorp.com/terraform/docs -## Prerequisites +## 2. Prerequisites - Basic linux command line skill and IaC concepts - Cloud (if working with cloud provider) -## Installation +## 3. Installation ### How to install Terraform? - https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli -## Basics of Terraform +## 4. Basics of Terraform ### Terraform getting started @@ -36,13 +36,13 @@ - See: [basic](./basic/) -## Beyond the Basics +## 5. Beyond the Basics ### Hands-On Example - For more hands-on examples, visit [aws-lab-with-terraform projects](https://github.com/tungbq/aws-lab-with-terraform) -## More... +## 6. More... ### Looking for a Terraform sample project with best practice?