How to write documentation

Where to place the documentations

Documentation structure

some-repository/
├── src/...
└── docs/
    ├── index.md
    ├── architecture.md
    ├── ....md
    └── img/
        └── some_picture.png

How to add a new repository to the documentation

Basic guidelines

Use Tags

Add the tags at the start of the .md files

tags:
  - samba-dc
  - troubleshooting
  -

Use following tags:

Products:

• managed-workplace
• managed-virtual-server
• ...

Services:

• single-sign-on
• samba-dc
• ...

Tools:

• keycloak
• ...

Type:

• manual
• troublesooting
• example
• architecture
• guideline