Skip to content

docs: add complete Modules 7 and 8 for reliability and platform engineering - #7

Merged
EdwinPhilip merged 1 commit into
mainfrom
docs/add-reliability-and-platform-engineering-modules
Oct 25, 2026
Merged

EdwinPhilip merged 1 commit into
mainfrom
docs/add-reliability-and-platform-engineering-modules

Conversation

@EdwinPhilip

@EdwinPhilip EdwinPhilip commented Oct 25, 2026 •

Copy link
Copy Markdown
Owner

Purpose

Publish two complete, general-purpose senior/lead platform engineering study modules using the existing VitePress site conventions. Preserve original module numbers 7 and 8. Modules 5 and 6 are now present on main and are preserved in this rebased PR. The new content remains numbered Modules 7 and 8.

Module 7: Cloud Architecture, Reliability & System Design

  1. SLIs, SLOs and error budgets
  2. High availability, zone failure and shared dependencies
  3. Deadlines, retries, circuit breaking and backpressure
  4. Transaction correctness, idempotency and event delivery
  5. Multi-region architecture, RPO/RTO and writer fencing
  6. Capacity planning, peak traffic, autoscaling and load testing
  7. Database/cache resilience and graceful degradation
  8. Incident leadership, game days and reliability/cost trade-offs

Includes 40 challenging follow-ups and complete model answers plus seven labs.

Module 8: CI/CD, GitOps & Platform Engineering

  1. Trusted CI/CD builds and immutable artifacts
  2. GitOps/Argo CD reconciliation, drift and ownership
  3. Progressive delivery, canary/blue-green and analysis
  4. Supply-chain security, SBOM, provenance and signing
  5. Identity, secrets and environment isolation
  6. Self-service platform contracts and golden paths
  7. Observability, platform SLOs and engineering effectiveness
  8. Multi-cluster governance, recovery and incident response

Includes 40 challenging follow-ups and complete model answers plus eight labs.

Technical content

  • 16 standalone chapters, each with interviewer-style prompts, first principles, mechanisms/flows, code and operational commands, hypothetical production incidents, decision trade-offs and natural spoken answers.
  • 24 native Mermaid diagrams (flowcharts, sequences and a state diagram), using the existing VitePress Mermaid integration.
  • 15 labs with expected observations and safety boundaries; no private employer projects, credentials or hostnames.
  • Public-domain generic marketplace, SaaS and cloud examples with version/platform caveats and authoritative reading links.

Files

  • Added docs/guides/reliability/{index,q1..q8,follow-ups,labs}.md (11 files).
  • Added docs/guides/platform-engineering/{index,q1..q8,follow-ups,labs}.md (11 files).
  • Updated docs/.vitepress/config.mts for navigation and both full sidebars.
  • Updated docs/guides/index.md to list Modules 7/8; Module 9 Python remains planned. Preserved the existing Modules 5 and 6 from latest main, with all their navigation and landing-page entries intact.

Validation

  • Confirmed 8 chapter files per module and full 40-question banks.
  • Confirmed 24 Mermaid blocks and balanced Markdown code fences.
  • Checked 26 module navigation/sidebar links against expected files and root base: '/'.
  • Checked new modules for private employer names; none found.
  • No new dependencies, deployment workflow permission changes or production workflow edits.
  • VitePress build: revalidation required after branch rebase and navigation change; see latest PR Actions run.
  • Local npm install and npm run docs:build were not run (network access unavailable to the local execution environment). PR validation workflow already uses these commands.

Expected URLs after merge and successful Pages deployment

Do not auto-merge. Please review rendered diagrams, technical content and CI results before merging.

Navigation revision and rebase

  • Rebased all Modules 7/8 documentation onto latest main commit b3e475dfd7ba83352e1c58af65a7405bc40c0fe7. The earlier feature-branch commits were consolidated into one new rebased commit.
  • Preserves all pre-existing Module 1-6 chapters, portfolio Home page, About page, VitePress Mermaid support and deployment workflow.
  • Top navigation now contains only Home, About me, GitHub and LinkedIn.
  • All eight published engineering modules appear in one consistent collapsible left sidebar, with Overview, a nested chapter list, labs and follow-up answers.
  • Retains local search, theme controls and the right-hand On this page outline.
  • Corrected Knowledge Base index to include Modules 5 and 6 from the latest main, followed by 7 and 8. Only Module 9 remains planned.
  • All changes stay within this PR. No merge performed.

@EdwinPhilip
EdwinPhilip force-pushed the docs/add-reliability-and-platform-engineering-modules branch from 7a24822 to 7e92c29 Compare October 25, 2026 12:32
@EdwinPhilip
EdwinPhilip merged commit aff4156 into main Oct 25, 2026
1 check passed
@EdwinPhilip
EdwinPhilip deleted the docs/add-reliability-and-platform-engineering-modules branch October 25, 2026 12:35
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.

1 participant