docs: following markdownlint rules for consistency closes #75

Here is a list of rules that have been applied:

- [MD009](https://github.com/DavidAnson/markdownlint/blob/main/doc/md009.md) -
  Trailing spaces
- [MD022](https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md) -
  Headings should be surrounded by blank lines
- [MD025](https://github.com/DavidAnson/markdownlint/blob/main/doc/md025.md) -
  Multiple top-level headings in the same document
- [MD026](https://github.com/DavidAnson/markdownlint/blob/main/doc/md026.md) -
  Trailing punctuation in heading
- [MD029](https://github.com/DavidAnson/markdownlint/blob/main/doc/md029.md) -
  Ordered list item prefix
- [MD031](https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md) -
  Fenced code blocks should be surrounded by blank lines
- [MD032](https://github.com/DavidAnson/markdownlint/blob/main/doc/md032.md) -
  Lists should be surrounded by blank lines
- [MD034](https://github.com/DavidAnson/markdownlint/blob/main/doc/md034.md) -
  Bare URL used
- [MD041](https://github.com/DavidAnson/markdownlint/blob/main/doc/md041.md) -
  First line in a file should be a top-level heading
- [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) -
  Files should end with a single newline character

docs: removal of duplicated links and improvements

Furthermore, duplicated links to the Official Cert-Manager Documentation
have been removed. Additionally, some files have been enhanced with
improved titles and added short descriptions.
This commit is contained in:
mdsanima 2023-06-01 08:28:09 +02:00
parent 7c8b8e215b
commit 7c25712177
No known key found for this signature in database
GPG Key ID: C7385033B505029B
7 changed files with 32 additions and 20 deletions

View File

@ -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 ✨.

View File

@ -1,10 +1,10 @@
# Christian's "Boilerplates"
# Christian's `Boilerplates`
Hi, there! 👋
Im 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 wont always be the case.
@ -25,4 +25,4 @@ If youd 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!_**

View File

@ -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/)

View File

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

View File

@ -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.

View File

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

View File

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