Skip to content

feat: add Site Reliability Engineering anchor#561

Merged
rdmueller merged 2 commits into
LLM-Coding:mainfrom
derryx:add-semantic-anchor-site-reliability-engineering
Jun 2, 2026
Merged

feat: add Site Reliability Engineering anchor#561
rdmueller merged 2 commits into
LLM-Coding:mainfrom
derryx:add-semantic-anchor-site-reliability-engineering

Conversation

@derryx
Copy link
Copy Markdown
Contributor

@derryx derryx commented Jun 2, 2026

Add SRE as a semantic anchor (EN + DE), covering SLI/SLO/SLA, error budgets, toil reduction, blameless postmortems, and the four golden signals. Filed under development-workflow with devops-engineer, software-architect, team-lead, and software-developer roles.

Sync the AgentSkill catalog and regenerate website metadata.

Summary by CodeRabbit

  • Dokumentation
    • Neue Ankerseite „Site Reliability Engineering (SRE)“ (EN/DE) mit Kernaussagen zu SLI/SLO/SLA, Fehlerbudget, Toil‑Reduktion und blameless Postmortems.
    • Ergänzte Abschnitte zu Monitoring & Observability (Golden Signals), Release‑ und Capacity‑Engineering sowie „Wann zu verwenden“ und verwandte Verweise.
    • Katalog‑ und Website‑Metadaten aktualisiert: neuer Anchor eintrag, Kategorien‑ und Rollen‑Zuordnungen sowie aggregierte Statistiken angepasst.

Add SRE as a semantic anchor (EN + DE), covering SLI/SLO/SLA,
error budgets, toil reduction, blameless postmortems, and the
four golden signals. Filed under development-workflow with
devops-engineer, software-architect, team-lead, and
software-developer roles.

Sync the AgentSkill catalog and regenerate website metadata.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 95db61a2-898d-4e36-9014-ec1522313189

📥 Commits

Reviewing files that changed from the base of the PR and between 629f923 and f5b904c.

📒 Files selected for processing (1)
  • docs/anchors/site-reliability-engineering.de.adoc

Walkthrough

Das PR fügt ein neues "Site Reliability Engineering"-Anchor zur Semantic-Anchors-Dokumentation hinzu. Dazu gehören zwei neue AsciiDoc-Dateien (Englisch und Deutsch) mit Kernkonzepten, ein Katalog-Eintrag, die Registrierung in der zentralen Anchor-JSON-Datei sowie Verknüpfungen mit einer Kategorie und vier Rollen. Die regenerierten Metadaten aktualisieren die Gesamtstatistiken.

Changes

SRE Anchor Integration

Layer / File(s) Summary
SRE Dokumentation und Katalog-Eintrag
docs/anchors/site-reliability-engineering.adoc, docs/anchors/site-reliability-engineering.de.adoc, skill/semantic-anchor-translator/references/catalog.md
Zwei neue AsciiDoc-Dokumentationsdateien definieren das SRE-Anchor mit Kernkonzepten (Operations as a software problem, SLI/SLO/SLA, Error Budget, Toil-Reduktion, blameless Postmortems, Monitoring & Observability, Release & Capacity Engineering) in Englisch und Deutsch, und der Katalog wird um einen SRE-Eintrag mit Aliases und Proponenten-Liste erweitert.
Anchor-Registrierung im zentralen Register
website/public/data/anchors.json
Das neue SRE-Anchor wird mit vollständiger Metadaten-Struktur registriert, einschließlich ID, Titel, Kategorien, Rollen, verwandter Anchors, Proponenten, Tags, Dateipfad und Tier-Klassifizierung.
Kategorie- und Rollen-Verknüpfung
website/public/data/categories.json, website/public/data/roles.json
Das SRE-Anchor wird in die "Development Workflow"-Kategorie und in die Anchor-Listen von vier Rollen (DevOps Engineer, Software Architect, Software Developer, Team Lead) aufgenommen.
Metadaten-Aktualisierung
website/public/data/metadata.json
Die Metadaten-Datei wird mit aktuellem Zeitstempel und aktualisierten Statistiken regeneriert: Anzahl der Anchors erhöht sich von 155 auf 156, sowie entsprechende Anpassungen bei durchschnittlichen Rollen pro Anchor und Zähler für Anchors mit Tags und verwandten Anchors.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • LLM-Coding/Semantic-Anchors#132: Fügt ebenfalls Einträge in skill/semantic-anchor-translator/references/catalog.md hinzu und ist thematisch an Katalog-/Anchor-Updates gebunden.
  • LLM-Coding/Semantic-Anchors#554: Beide PRs aktualisieren Anchors und die gemeinsame Datenpipeline (anchors.json, roles.json, categories.json).
  • LLM-Coding/Semantic-Anchors#209: Beide PRs regenerieren und modifizieren Website-Metadaten (metadata.json, anchors.json) im Rahmen von Anchor-Erweiterungen.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel beschreibt präzise die Hauptänderung: Hinzufügung eines neuen Site Reliability Engineering Anchors.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/anchors/site-reliability-engineering.adoc`:
- Line 1: The top-level AsciiDoc header in site-reliability-engineering.adoc
uses a single '='; change the opening header line to start with '== ' (double
equals plus a space) so the file follows the repo guideline that top-level
sections use '=='; verify any adjacent sections maintain proper nesting after
this change.

In `@docs/anchors/site-reliability-engineering.de.adoc`:
- Line 1: The top-level AsciiDoc header currently uses a single equals sign ("=
Site Reliability Engineering"); update it to start with two equals signs ("==
Site Reliability Engineering") to conform to the repository's AsciiDoc guideline
for top-level headers (see the "*.adoc" rule). Locate the header string "= Site
Reliability Engineering" and replace the leading "=" with "==" so the file's
top-level heading matches the required format.
- Around line 1-4: The German semantic anchor "Site Reliability Engineering" is
missing the required metadata attribute :proponents:; update the anchor (the
document whose title is "= Site Reliability Engineering") to include a
:proponents: line with the appropriate comma-separated proponent roles or names
(e.g., :proponents: devops-team, platform-team) directly under the existing
attributes so the file conforms to the docs/anchors/*.adoc metadata contract.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: ddd70d54-956c-4fd1-95ad-3635d4c10a19

📥 Commits

Reviewing files that changed from the base of the PR and between 90ee697 and 629f923.

📒 Files selected for processing (7)
  • docs/anchors/site-reliability-engineering.adoc
  • docs/anchors/site-reliability-engineering.de.adoc
  • skill/semantic-anchor-translator/references/catalog.md
  • website/public/data/anchors.json
  • website/public/data/categories.json
  • website/public/data/metadata.json
  • website/public/data/roles.json

@@ -0,0 +1,51 @@
= Site Reliability Engineering
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Top-Level-Überschrift auf Guideline-Format umstellen.

Für .adoc soll die oberste Abschnittsebene mit == beginnen; aktuell wird mit = gestartet. Bitte auf konsistente Abschnittsstruktur gemäß Repo-Regel umstellen.

As per coding guidelines **/*.adoc: “All AsciiDoc files must have sections using proper nesting levels starting with == for top-level headers”.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/anchors/site-reliability-engineering.adoc` at line 1, The top-level
AsciiDoc header in site-reliability-engineering.adoc uses a single '='; change
the opening header line to start with '== ' (double equals plus a space) so the
file follows the repo guideline that top-level sections use '=='; verify any
adjacent sections maintain proper nesting after this change.

@@ -0,0 +1,47 @@
= Site Reliability Engineering
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Top-Level-Überschrift auf == normalisieren.

Auch hier beginnt die oberste Überschrift mit = statt mit == laut AsciiDoc-Regel im Repository.

As per coding guidelines **/*.adoc: “starting with == for top-level headers”.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/anchors/site-reliability-engineering.de.adoc` at line 1, The top-level
AsciiDoc header currently uses a single equals sign ("= Site Reliability
Engineering"); update it to start with two equals signs ("== Site Reliability
Engineering") to conform to the repository's AsciiDoc guideline for top-level
headers (see the "*.adoc" rule). Locate the header string "= Site Reliability
Engineering" and replace the leading "=" with "==" so the file's top-level
heading matches the required format.

Comment thread docs/anchors/site-reliability-engineering.de.adoc Outdated
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@raifdmueller
Copy link
Copy Markdown
Contributor

Analysis — strong qualify ✅

Reviewed against the catalog's quality criteria:

Criterion Verdict Notes
Precise SRE is a well-bounded discipline: SLI/SLO/SLA, error budgets, toil reduction, blameless postmortems, the four golden signals.
Rich Activates a wide interconnected domain — reliability targets, error-budget policy, on-call/incident response, observability, capacity & release engineering, postmortem culture.
Consistent Very high, stable LLM activation (Google's SRE book is canonical).
Attributable Ben Treynor Sloss (coined SRE at Google) + the SRE book authors (Beyer, Jones, Petoff, Murphy).

PR mechanics: clean — EN + DE, catalog synced, metadata regenerated additively (0 deletions in anchors.json, no drift). Category development-workflow and the role set (devops-engineer / software-architect / team-lead / software-developer) are sensible.

Minor, non-blocking suggestions:

  • :related: is a bit statistics-heavy (spc, control-chart-shewhart). The SLO-monitoring link is defensible, but definition-of-done (error-budget as a release gate) and event-driven-architecture/regulated-environment might be more intuitive neighbours. Keep five-whys — it's the right RCA link for blameless postmortems.
  • Consider a "When NOT to use" note (e.g. tiny projects without meaningful SLOs) for parity with other anchors.

Verdict: ready to merge once CI is green. Thanks @derryx!

@raifdmueller
Copy link
Copy Markdown
Contributor

Re: the CodeRabbit findings — none are blocking

Checked all three against the current PR head:

  1. "Top-level header should be == not =" (EN, Minor) — false positive. Anchor files use = Title as the AsciiDoc doctitle by design; that's the convention across all 150+ existing anchors (grasp.adoc, clean-architecture.adoc, …) and what extract-metadata/the modal use to derive the title. Switching to == would break title extraction. The generic "start with ==" rule doesn't apply to anchor files.
  2. Same for the German file — false positive, same reason.
  3. ":proponents: missing in the German anchor" (Major) — false positive / stale. :proponents: is present in site-reliability-engineering.de.adoc (line 4). CodeRabbit most likely reviewed an earlier commit.

One real (minor) thing CodeRabbit missed: the German file omits :related:, :tags: and :tier: that the English file carries. It's functionally harmless — metadata is derived from the English .adoc — but for consistency with the other DE anchors you could mirror those three attributes into site-reliability-engineering.de.adoc. Optional, not a blocker.

Otherwise the PR looks good (additive metadata, sensible category/roles, all CI green). 👍

@rdmueller rdmueller merged commit 18bc229 into LLM-Coding:main Jun 2, 2026
8 checks passed
rdmueller pushed a commit that referenced this pull request Jun 2, 2026
The German Site Reliability Engineering anchor carried only categories,
roles and proponents, while the English file also has :related:, :tags:
and :tier:. Mirror those three (and the blank line before the collapsible
block) so the EN/DE attribute headers match the rest of the catalog.
Functionally a no-op — metadata is derived from the English file — purely
source consistency. Follow-up to #561.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

3 participants