CCCHH/ansible-infra
CCCHH/ansible-infra
2
2
Fork 1
Code Issues 7 Pull requests 8 Wiki Activity Actions

fix multiple typos
Some checks failed
/ Ansible Lint (push) Successful in 2m22s
Details
/ Ansible Lint (pull_request) Successful in 2m22s
Details
/ build (pull_request) Failing after 2m39s
Details
/ cleanup-staging (pull_request) Failing after 2m17s
Details

Browse source
This commit is contained in:
forestcat-admin 2026-05-27 20:40:54 +02:00 • committed by forestcat-admin
commit 51f5b2cbbc
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/concepts-and-configurations/documentation-structure.md
View file

@ -7,7 +7,7 @@ summary: >-
!!! info "Info" !!! info "Info"
If youre looking for a hands-on approach on how documentation is to be written you can find a [guide](../guides/writing-documentation.md) explaining the process. If you're unsure how to start you can find [templates](../guides/writing-documentation.md#3-addedit-your-markdown-file) there aswell. If you're looking for a hands-on approach on how documentation is to be written you can find a [guide](../guides/writing-documentation.md) explaining the process. If you're unsure how to start you can find [templates](../guides/writing-documentation.md#3-addedit-your-markdown-file) there aswell.
## General Rules ## General Rules
These rules are general formatting and writing decisions that apply to every document. Their goal is to provide a concise style across the whole documentation to keep the text easy to follow. These rules are general formatting and writing decisions that apply to every document. Their goal is to provide a concise style across the whole documentation to keep the text easy to follow.
@ -25,7 +25,7 @@ The scope for a document should be set to define responsibility and set boundari
We generally distinguish between concepts, configurations and guides in this documentation. Their separation should be clarified with folowing list: We generally distinguish between concepts, configurations and guides in this documentation. Their separation should be clarified with folowing list:
- **Concept:** A concept includes an abstract definition about a specific structure while not going into implementation details. It is a document intending to further the abstract understanding of structure. It can also go into detail about _why_ we do things a certain way. - **Concept:** A concept includes an abstract definition about a specific structure while not going into implementation details. It is a document intending to further abstract the understanding of structure. It can also go into detail about _why_ we do things a certain way.
- **Configuration:** A configuration can be a follow up of a concept, explaining the specific implementation in a given environment. - **Configuration:** A configuration can be a follow up of a concept, explaining the specific implementation in a given environment.
- **Guide:** A guide is a step-by-step hands-on instruction for the reader to follow along. It can reference concepts and configurations. The important difference to the other two document types is that guides are goal oriented. Understanding how things work is secondary to achieving a specific thing. - **Guide:** A guide is a step-by-step hands-on instruction for the reader to follow along. It can reference concepts and configurations. The important difference to the other two document types is that guides are goal oriented. Understanding how things work is secondary to achieving a specific thing.