Commit Graph

4 Commits

Author SHA1 Message Date
Christoph Schug 2f56d1cd53 fix: update URLs in contributing document 2024-02-24 00:58:12 +01:00
mdsanima 7c25712177
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.
2023-06-01 08:51:32 +02:00
Zaira ad3d762612
doc: added contributing.md 2022-06-08 19:12:17 +05:00
Zaira 9ce24c5ab6
Add CONTRIBUTING.md 2022-06-08 18:59:26 +05:00