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

Merged
merged 48 commits into from
Jan 17, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
86c1300
initial idea dump
tobru Dec 31, 2024
322a5bf
initial try at templating with cookiecutter
tobru Jan 3, 2025
0b42d26
addr is now adr and cookiecutter templates
tobru Jan 3, 2025
c893420
wip including index creation tool
tobru Jan 3, 2025
c33e479
add pre-commit hook to generate adr index
tobru Jan 6, 2025
f429753
add status validation
tobru Jan 6, 2025
a6b6c0e
slugify adr filename
tobru Jan 6, 2025
c02a8e6
document adr
tobru Jan 6, 2025
3c8c991
continuation
tobru Jan 6, 2025
01c9854
Update docs/modules/ROOT/partials/service-meta.adoc
tobru Jan 6, 2025
01f55bd
add convenience symlink
tobru Jan 6, 2025
bac2b17
output adr path at the end
tobru Jan 6, 2025
4c75dbf
auto-increment ADR number in cookiecutter config
tobru Jan 7, 2025
fd03913
document adr tooling
tobru Jan 7, 2025
15c6c47
cleanup service metadata
tobru Jan 7, 2025
9fabbb5
move postgresql docs to the new place
tobru Jan 7, 2025
e21e484
remove very old and outdated billing docs
tobru Jan 7, 2025
5587682
improve service template
tobru Jan 7, 2025
49c68e7
move redis docs to the new place
tobru Jan 7, 2025
eebb452
include tags in adr index
tobru Jan 7, 2025
0d672b0
move mariadb docs to the new place
tobru Jan 7, 2025
08f1369
move minio docs to the new place
tobru Jan 7, 2025
38f8441
remove pointless crossplane decision
tobru Jan 10, 2025
59823f2
adr service location
tobru Jan 10, 2025
7dd5266
adr service logging
tobru Jan 10, 2025
d5bdf8c
adr composition and xrd deployment
tobru Jan 10, 2025
79f7f2a
adr metrics
tobru Jan 10, 2025
fcc80bb
adr service api design
tobru Jan 10, 2025
f0a3a0d
adr capacity alerting
tobru Jan 10, 2025
57db7f2
adr deletion protection
tobru Jan 10, 2025
87b00ab
adr user management
tobru Jan 10, 2025
6aaadc9
adr comp function error handling
tobru Jan 10, 2025
0163b7d
adr api server
tobru Jan 10, 2025
71655ef
adr release process
tobru Jan 10, 2025
dd753c8
adr secret management tool
tobru Jan 10, 2025
5b941f0
adr nextcloud helm
tobru Jan 10, 2025
00ce4bc
adr mongodb operator
tobru Jan 10, 2025
30f94ec
adr keycloak
tobru Jan 10, 2025
6e7b3fd
adr sli prober object storage
tobru Jan 10, 2025
14de31f
adr obsolete converged service
tobru Jan 10, 2025
089c955
move exoscale stuff around
tobru Jan 13, 2025
ca21fac
move spks stuff around
tobru Jan 13, 2025
62e3a06
i want to move it move it
tobru Jan 13, 2025
395bfa2
script to check navigation
tobru Jan 13, 2025
436d44d
move forgejo codey around
tobru Jan 13, 2025
787f1fc
add vale config
tobru Jan 13, 2025
15ed6d3
Revert "add vale config"
tobru Jan 13, 2025
dc33b95
ignore Microsoft.RangeFormat in vale
tobru Jan 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adr deletion protection
  • Loading branch information
tobru committed Jan 13, 2025
commit 57db7f27d89435529d72431f39496b0799b8255a
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
= Decision on SLA Reports
= ADR 0018 - SLA Reports Handling
:adr_author: Gabriel Saratura
:adr_owner: Schedar
:adr_reviewers: Schedar
:adr_date: 2023-05-08
:adr_upd_date: 2023-05-09
:adr_status: implemented
:adr_tags: framework,sla,reports
:page-aliases: explanations/decisions/sla-reports.adoc

include::partial$adr-meta.adoc[]

[NOTE]
.Summary
====
We use a custom tool to create SLA reports.
====

== Problem

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
= Deletion Protection
= ADR 0019 - Deletion Protection with Validating Webhook
:adr_author: Simon Beck
:adr_owner: Schedar
:adr_reviewers: Schedar
:adr_date: 2024-03-14
:adr_upd_date: 2024-03-18
:adr_status: implemented
:adr_tags: framework,service
:page-aliases: explanations/decisions/deletion-protection.adoc

include::partial$adr-meta.adoc[]

[NOTE]
.Summary
====
We use a custom validation webhook to implement deletion protection for service instances.
====

== Problem

Expand Down
8 changes: 8 additions & 0 deletions docs/modules/ROOT/pages/adr/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,12 @@

`framework,service,alerting`
|implemented |2023-02-24 |2023-03-02
|xref:adr/0018-sla-reports-handling.adoc[]

`framework,sla,reports`
|implemented |2023-05-08 |2023-05-09
|xref:adr/0019-deletion-protection-with-validating-webhook.adoc[]

`framework,service`
|implemented |2024-03-14 |2024-03-18
|===
4 changes: 3 additions & 1 deletion docs/modules/ROOT/partials/nav-adrs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@
** xref:adr/0014-commodore-component-to-deploy-compositions-and-xrds.adoc[]
** xref:adr/0015-metrics-and-monitoring-of-services.adoc[]
** xref:adr/0016-service-api-design.adoc[]
** xref:adr/0017-handling-of-capacity-alerts-for-incident-prevention.adoc[]
** xref:adr/0017-handling-of-capacity-alerts-for-incident-prevention.adoc[]
** xref:adr/0018-sla-reports-handling.adoc[]
** xref:adr/0019-deletion-protection-with-validating-webhook.adoc[]
2 changes: 0 additions & 2 deletions docs/modules/ROOT/partials/nav_orig.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,7 @@
** xref:app-catalog:ROOT:explanations/decisions/nextcloud.adoc[Nextcloud by VSHN]
** xref:app-catalog:ROOT:explanations/decisions/mongodb.adoc[MongoDB by VSHN]
** xref:app-catalog:ROOT:explanations/decisions/secret-pki-mgmt.adoc[Secret and PKI Management by VSHN]
** xref:app-catalog:ROOT:explanations/decisions/sla-reports.adoc[SLA Reports]
** xref:app-catalog:ROOT:explanations/decisions/apiserver.adoc[API Server Replacement]
** xref:app-catalog:ROOT:explanations/decisions/deletion-protection.adoc[]
** xref:app-catalog:ROOT:explanations/decisions/user-management.adoc[]
** xref:app-catalog:ROOT:explanations/decisions/comp-function-error-handling.adoc[]
** xref:app-catalog:ROOT:explanations/decisions/release_process.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion templates/adr/cookiecutter.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"adr_number": "0018",
"adr_number": "0020",
"full_name": "VSHNeer Name",
"adr_title": "Title",
"adr_reviewers": "",
Expand Down