Setup area for infrastructure documentation #1644
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR establishes a new documentation area for infrastructure-related content within the project's documentation structure. The changes create a foundation for the infrastructure community to document toolchains, CI/CD practices, and development tools.
- Creates a new infrastructure documentation section with defined scope covering integration, automation, and common toolchains
- Adds placeholder for decision records (DR-001)
- Updates documentation configuration to support Markdown and Mermaid diagrams
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/infrastructure/index.rst | Creates main infrastructure documentation index with scope definition and decision records structure |
| docs/infrastructure/DR-001.md | Adds placeholder decision record file |
| docs/index.rst | Links new infrastructure section to main documentation table of contents |
| docs/conf.py | Adds myst_parser and mermaid extensions, updates type annotation |
| .github/CODEOWNERS | Assigns infrastructure documentation ownership and reorganizes comments |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
The created documentation from the pull request is available at: docu-html |
|
I would prefer to locate DRs in a central place like in my pull request which is currently blocked: #1408 Is it only documentation or is it also decisions? |
docs/requirements or docs/infrastructure seems for me same central places, then I would propose to add it here /docs/requirements/stakeholder/ |
|
For now my need is to document decision records. Some are about design, but not all. I don't have the text at hand, so I'll just copy a screenshot as an example :) |
Leaving a team within their company does not affect committer status within open source. |
But it does not help, if people are not any more in project are gating people and they will not show-up any more, I think we need discussion here |
As this involves a crazy amount of reviewers, I'm creating a separate PR without actual content just to setup an area for infrastructure documentation.
The goal here is for the infrastructure community to have a place where we can document stuff. Once we have a better understanding of the actual content, it will be easier to decide how exactly we want to structure it.