Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework Documentation Structure - Introduce ADRs #131

Draft
wants to merge 22 commits into
base: master
Choose a base branch
from
Draft

Conversation

tobru
Copy link
Member

@tobru tobru commented Dec 31, 2024

This PR overhauls the documentation and introduces the concept of ADRs - Architecture Design or Decision Records.

@tobru tobru changed the title Rework Documentation Structure - Introduce ADDRs Rework Documentation Structure - Introduce ADRs Jan 3, 2025
Co-authored-by: wejdross <lukaszwidera1993@gmail.com>
Copy link
Member

@wejdross wejdross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

few things from me:

  • please document Your python scripts, like 2-3 lines of summary so we don't need to write code
  • if URLs of runbooks change, we need to update our alerts, or maintain redirects

Other than that, I like this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants