topic: using common template for prometheus | python | shell | terraf…

…orm (#482)

topics/prometheus/README.md

@@ -1,19 +1,55 @@
-# What is Prometheus?
+## What is Prometheus?
+
 - https://prometheus.io/docs/introduction/overview/#what-is-prometheus
 
+### Overview
+
+- Prometheus is an open-source systems monitoring and alerting toolkit originally built at SoundCloud.
+
+### Prometheus architecture
 
-# Prometheus Architecture
 <img src="../../assets/images/prometheus/prometheus-architecture.png" width="700">
 
 - (Image source provided by https://prometheus.io/docs/introduction/overview/#architecture)
 
-# How to install Prometheus
+### Official website documentation of Prometheus
+
+- https://prometheus.io/docs/introduction/overview/
+
+## Prerequisites
+
+- Linux, Helm, k8s
+
+## Installation
+
+### How to install Prometheus?
+
 - https://prometheus.io/docs/prometheus/latest/installation/
 
-# Prometheus Helloworld Hands-on
-- Required knowledge in [helm](../../topics/helm/) | [k8s](../../topics/k8s/) first for better understanding. Because we will deploy our own Prometheus to K8s using Helm
-- Run the demo scipt: `cd hello-world; ./prometheus-helloworld.sh`
-- (Optional) Run the demo scipt and cleanup right after the demo: `cd hello-world; ./prometheus-helloworld.sh true`
+## Basics of Prometheus
+
+### Prometheus getting started
 
-# Getting started with Prometheus
 - https://prometheus.io/docs/prometheus/latest/getting_started/
+
+### Prometheus Hello World
+
+- Required knowledge in [helm](../../topics/helm/) | [k8s](../../topics/k8s/) first for better understanding. Because we will deploy our own Prometheus to K8s using Helm
+- 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
+
+### Hands-On Example
+
+- Check the [advanced/](./advanced/) directory for more Prometheus examples.
+
+## More...
+
+### Prometheus cheatsheet
+
+- None
+
+### Recommended Books
+
+- None

topics/prometheus/advanced/README.md

@@ -0,0 +1 @@
+# TODO

topics/python/README.md

@@ -1,24 +1,53 @@
-# Python
+## What is Python?
 
-## Why python in DevOps?
+### Overview
 
-- Python's combination of simplicity, power, extensive libraries, community support, and adaptability to various DevOps tasks makes it a go-to language for many professionals in this field. Its effectiveness in automating workflows, managing infrastructure, and integrating with a plethora of tools solidifies its role as a key player in the DevOps landscape.
+- Python's combination of simplicity, power, extensive libraries, community support, and adaptability to various DevOps tasks makes it a go-to language for many professionals in this field.
+- Its effectiveness in automating workflows, managing infrastructure, and integrating with a plethora of tools solidifies its role as a key player in the DevOps landscape.
 
-## Getting Started with Python
+### Python workflow
 
-- If you're new to Python, the Python Official Getting Started Guide provides comprehensive insights into setting up and beginning your Python journey.
-- https://www.python.org/about/gettingstarted/
+- None
+
+### Official website documentation of Python
+
+- https://www.python.org/doc/
+
+## Prerequisites
 
-## Download Python
+- None
+
+## 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/
 
-## Python Hello World Example
+## Basics of Python
+
+### Python getting started
+
+- If you're new to Python, the Python Official Getting Started Guide provides comprehensive insights into setting up and beginning your Python journey.
+- https://www.python.org/about/gettingstarted/
+
+### Python Hello World
 
 - 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`
 
-## Python script example
+## Beyond the Basics
+
+### Hands-On Example
+
+- Find more examples at [advanced](./advanced/)
+
+## More...
+
+### Python cheatsheet
+
+- None
+
+### Recommended Books
 
-- Find more examples at [examples](./examples/)
+- None

topics/shell/README.md

@@ -1,7 +1,50 @@
-# Get started at
+## What is Shell?
 
-- [basic](./basic.sh)
+### Overview
 
-# Do some practice execise at
+- A shell script is a computer program designed to be run by a Unix shell, a command-line interpreter. The various dialects of shell scripts are considered to be scripting languages.
+- Typical operations performed by shell scripts include file manipulation, program execution, and printing text. A script which sets up the environment, runs the program, and does any necessary cleanup or logging, is called a wrapper.
 
-- [excercise](./excercise/)
+### Shell workflow
+
+- None
+
+### Official website documentation of Shell
+
+- https://en.wikipedia.org/wiki/Shell_script
+
+## Prerequisites
+
+- K8s, docker, linux
+
+## Installation
+
+### How to install Shell?
+
+- Just install Linux then you would have shell enviroment as well
+
+## Basics of Shell
+
+### Shell getting started
+
+- https://www.shellscript.sh/
+
+### Shell Hello World
+
+- See: [basic](./basic/)
+
+## Beyond the Basics
+
+### Hands-On Example
+
+- Do more practice execises at [advanced](./advanced/)
+
+## More...
+
+### Shell cheatsheet
+
+- None
+
+### Recommended Books
+
+- None

topics/terraform/README.md

@@ -1,27 +1,57 @@
-# What is Terraform?
+## What is Terraform?
 
 - https://developer.hashicorp.com/terraform/intro
 
-# How does Terraform work?
+### Overview
+
+- HashiCorp Terraform is an infrastructure as code tool that lets you define both cloud and on-prem resources in human-readable configuration files that you can version, reuse, and share.
+- You can then use a consistent workflow to provision and manage all of your infrastructure throughout its lifecycle. Terraform can manage low-level components like compute, storage, and networking resources, as well as high-level components like DNS entries and SaaS features.
+
+### Terraform workflow
 
 - https://developer.hashicorp.com/terraform/intro#how-does-terraform-work
 
-# Why Terraform?
+### Official website documentation of Terraform
+
+- https://developer.hashicorp.com/terraform/docs
+
+## Prerequisites
 
-- https://developer.hashicorp.com/terraform/intro#why-terraform
+- Basic linux command line skill and IaC concepts
+- Cloud (if working with cloud provider)
 
-# How to install terraform
+## Installation
+
+### How to install Terraform?
 
 - https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli
 
-# Getting started with Terraform
+## Basics of Terraform
+
+### Terraform getting started
 
 - https://developer.hashicorp.com/terraform/tutorials/aws-get-started
 
-# To get more hands on example
+### Terraform Hello World
+
+- See: [basic](./basic/)
 
-- Visit [aws-lab-with-terraform](https://github.com/tungbq/aws-lab-with-terraform)
+## Beyond the Basics
 
-# Looking for a Terraform sample project with best practice?
+### Hands-On Example
+
+- For more hands-on examples, visit [aws-lab-with-terraform projects](https://github.com/tungbq/aws-lab-with-terraform)
+
+## More...
+
+### Looking for a Terraform sample project with best practice?
 
 - Check out: [terraform-sample-project](https://github.com/tungbq/terraform-sample-project)
+
+### Terraform cheatsheet
+
+- None
+
+### Recommended Books
+
+- None

topics/terraform/basic/README.md

@@ -0,0 +1,5 @@
+# Basics of Terraform
+
+## Demo
+
+Run `./terraform-helloworld.sh`