Răsfoiți Sursa

Merge pull request #76 from mdsanima/docs-fix-markdownlint

Following `markdownlint` rules to enforce standards and consistency
Christian Lempa 2 ani în urmă
părinte
comite
898ceddd71

+ 7 - 4
CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Welcome to contributing at The Digital Life.🤝
+# Welcome to contributing at The Digital Life.🤝
 
 - Products continuously change over time, specially those that are in high demand.
 
@@ -13,13 +13,16 @@ To get an overview of the project, read the [README](https://github.com/xcad2k/b
 ## Issues
 
 ### Create a new issue
-If you spot a problem with the templates, search if that issue already exists. 
+
+If you spot a problem with the templates, search if that issue already exists.
 If a relevant issue doesn't exist, you can open a new issue in the issue's tab.
 
 ### Solve an issue
-Search through the existing issues to find one that interests you. You can refine the search using labels as filters. 
+
+Search through the existing issues to find one that interests you. You can refine the search using labels as filters.
 Once you find an issue to work on, you are welcome to open a PR with a fix.
 
-## Your PR is merged!
+## Your PR is merged
+
 Once reviewed and accepted, your PR would be merged and available publicly.
 Congratulations 🎉🎉 and thank you for playing your part ✨.

+ 3 - 3
README.md

@@ -1,10 +1,10 @@
-# Christian's "Boilerplates"
+# Christian's `Boilerplates`
 
 Hi, there! 👋
 
 I’m Christian, a 35-year-old tech enthusiast from Germany, and I love to inspire and educate people in IT.
 
-This Repository **Boilerplates** is my personal template collection. Here you'll find templates, and configurations for various tools, and technologies. 
+This Repository **Boilerplates** is my personal template collection. Here you'll find templates, and configurations for various tools, and technologies.
 
 > :warning: Be aware, products can change over time. I do my best to keep up with the latest changes and releases, but please understand that this won’t always be the case.
 
@@ -25,4 +25,4 @@ If you’d like to contribute to this project, reach out to me on social media o
 
 [Becoming a Patreon](https://www.patreon.com/christianlempa) will support my mission to create free, high-quality content for tech enthusiasts and IT professionals.
 
-***Help me to create something that matters to people!***
+**_Help me to create something that matters to people!_**

+ 11 - 11
kubernetes/certmanager/README.md

@@ -1,14 +1,18 @@
-# Installation
+# Kubernetes Cert-Manager Installation Guide
+
+Here is the installation guide for Cert-Manager and the complete configuration.
 
 ## Deployment
 
-1. Add the Helm Repository & Update
+### 1. Add the Helm Repository & Update
+
 ```bash
 helm repo add jetstack https://charts.jetstack.io
-
 helm repo update
 ```
-2. Install Cert-Manager with Helm & CRDs
+
+### 2. Install Cert-Manager with Helm & CRDs
+
 ```bash
 helm install cert-manager jetstack/cert-manager --namespace cert-manager --create-namespace --set installCRDs=true
 ```
@@ -17,16 +21,12 @@ helm install cert-manager jetstack/cert-manager --namespace cert-manager --creat
 
 Add your Issuer or ClusterIssuer Objects, Credentails and Certificates.
 
-*For more info visit:* [Official Cert-Manager Documentation](https://cert-manager.io/docs/)
+_For more info visit:_ [Official Cert-Manager Documentation](https://cert-manager.io/docs/)
 
-# Best-Practices & Post-Installation
+## Best-Practices & Post-Installation
 
 ## Troubleshooting
 
 You can troubleshoot issues and inspect log entries for the Certificate Objects with the `kubectl describe` command.
 
-*For more info visit:* [Official Cert-Manager Troubleshooting Guide](https://cert-manager.io/docs/faq/troubleshooting/)
-
-# Additional Referfences
-
-[Official Cert-Manager Documentation](https://cert-manager.io/docs/)
+_For more info visit:_ [Official Cert-Manager Troubleshooting Guide](https://cert-manager.io/docs/faq/troubleshooting/)

+ 3 - 0
kubernetes/portainer/README.md

@@ -0,0 +1,3 @@
+# Kubernetes Portainer
+
+You can add an additional description here.

+ 2 - 2
kubernetes/traefik/README.md

@@ -1,5 +1,5 @@
-# Traefik Helm Deployment
+# Kubernetes Traefik Helm Deployment
 
-This Deployment uses the official Helm Chart from traefik.io https://github.com/traefik/traefik-helm-chart.
+This Deployment uses the official Helm Chart from [traefik](https://github.com/traefik/traefik-helm-chart) repository.
 
 These are templates to modify the deployment.

+ 3 - 0
packer/proxmox/README.md

@@ -0,0 +1,3 @@
+# Packer Proxmox
+
+You can add an additional description here.

+ 3 - 0
terraform/proxmox/README.md

@@ -0,0 +1,3 @@
+# Terraform Proxmox
+
+You can add an additional description here.