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.

Sign up for GitHub

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

Jump to bottom

Rework Documentation Structure - Introduce ADRs #131

Merged
merged 48 commits into from
Jan 17, 2025
Merged

Rework Documentation Structure - Introduce ADRs #131

merged 48 commits into from
Jan 17, 2025

Conversation

tobru
Copy link
Member

@tobru tobru commented Dec 31, 2024 •
edited
Loading

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
wejdross
wejdross reviewed Jan 6, 2025
View reviewed changes
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.

tobru and others added 27 commits January 13, 2025 17:38
@tobru
initial idea dump
86c1300
@tobru
initial try at templating with cookiecutter
322a5bf
@tobru
addr is now adr and cookiecutter templates
0b42d26
@tobru
wip including index creation tool
c893420
@tobru
add pre-commit hook to generate adr index
c33e479
@tobru
add status validation
f429753
@tobru
slugify adr filename
a6b6c0e
@tobru
document adr
c02a8e6
@tobru
continuation
3c8c991
@tobru @wejdross
Update docs/modules/ROOT/partials/service-meta.adoc
01c9854 
Co-authored-by: wejdross <[email protected]>
@tobru
add convenience symlink
01f55bd
@tobru
output adr path at the end
bac2b17
@tobru
auto-increment ADR number in cookiecutter config
4c75dbf
@tobru
document adr tooling
fd03913
@tobru
cleanup service metadata
15c6c47
@tobru
move postgresql docs to the new place
9fabbb5
@tobru
remove very old and outdated billing docs
e21e484
@tobru
improve service template
5587682
@tobru
move redis docs to the new place
49c68e7
@tobru
include tags in adr index
eebb452
@tobru
move mariadb docs to the new place
0d672b0
@tobru
move minio docs to the new place
08f1369
@tobru
remove pointless crossplane decision
38f8441
@tobru
adr service location
59823f2
@tobru
adr service logging
7dd5266
@tobru
adr composition and xrd deployment
d5bdf8c
@tobru
adr metrics
79f7f2a
@tobru tobru marked this pull request as ready for review January 13, 2025 16:46
@tobru tobru requested review from a team, Kidswiss, TheBigLee and zugao and removed request for a team January 17, 2025 11:19
@tobru tobru merged commit 7903004 into master Jan 17, 2025
1 check passed
@tobru tobru deleted the cleanup branch January 17, 2025 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wejdross wejdross wejdross left review comments

@Kidswiss Kidswiss Awaiting requested review from Kidswiss Kidswiss was automatically assigned from vshn/schedar

@TheBigLee TheBigLee Awaiting requested review from TheBigLee TheBigLee was automatically assigned from vshn/schedar

@zugao zugao Awaiting requested review from zugao zugao was automatically assigned from vshn/schedar

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tobru @wejdross