Skip to content

docs(course): drop the phase tags and the workflow built on them - #200

Merged
vovinacci merged 2 commits into
mainfrom
docs/drop-phase-tags
Jul 27, 2026
Merged

docs(course): drop the phase tags and the workflow built on them#200
vovinacci merged 2 commits into
mainfrom
docs/drop-phase-tags

Conversation

@vovinacci

@vovinacci vovinacci commented Jul 27, 2026

Copy link
Copy Markdown
Owner

The phase tags were never pushed. origin carries only v1.1.0-v1.5.0, so git diff phase-2..phase-3 fails for everyone who clones this repo -- the course promised a history workflow no reader could run, in eleven places.

Pushing them was the alternative, and it is worse. Every tag predates the loopback port binding and the dashboard uid fix: all eight publish ports on every interface (8 mappings at phase-0, rising to 18 at rfc-0002) and none pins a dashboard uid. Publishing eight trees that put Postgres on the wire, to an audience that will check them out and run them, is not worth a diff convenience. Better to not ship the footgun than to document it.

The construction history is unaffected: every phase is a run of PRs on main, RFC-0001 Section 9 lists what each delivered, and the ADRs froze the decisions. The Tag column, the checkout instruction, the read-only-checkpoint paragraph, and the two "the rfc-000N tag will mark it" promises are gone.

Tags deleted locally, recreatable from these commits if ever wanted:

phase-0 8775267 Phase 0: repo restructure, CI, baseline hardening (#143)
phase-1 99d458a Phase 1: three-layer monitoring, canary v1 (#159)
phase-2 23170c3 Phase 2: contract-first gRPC + OpenTelemetry (#162)
phase-3 a8ccbc0 Phase 3: Go analytics, pipeline-lag canary v2 (#167)
phase-4 ec4810b Phase 4: load profile, Alertmanager, e2e gate (#172)
phase-5 9cb1b1f Phase 5: historical seeder, workshop mode (#175)
phase-6 393989a Phase 6: Kotlin reports, report load, canary v3 (#180)
rfc-0002 e4bbafc RFC-0002: reports-ui Caddy static SPA (#182)

All eight are ancestors of main, so the commits stay reachable regardless.

Summary by CodeRabbit

  • Documentation
    • Updated course guidance to use the live main branch as the source of truth.
    • Simplified the course map by removing tag and checkpoint references.
    • Revised module descriptions to reflect current design status without tag references.
    • Updated platform history guidance to use commit history alongside RFCs and ADRs.

The phase tags were never pushed. origin carries only v1.1.0-v1.5.0, so
`git diff phase-2..phase-3` fails for everyone who clones this repo -- the
course promised a history workflow no reader could run, in eleven places.

Pushing them was the alternative, and it is worse. Every tag predates the
loopback port binding and the dashboard uid fix: all eight publish ports on
every interface (8 mappings at phase-0, rising to 18 at rfc-0002) and none
pins a dashboard uid. Publishing eight trees that put Postgres on the wire,
to an audience that will check them out and run them, is not worth a diff
convenience. Better to not ship the footgun than to document it.

The construction history is unaffected: every phase is a run of PRs on main,
RFC-0001 Section 9 lists what each delivered, and the ADRs froze the
decisions. The Tag column, the checkout instruction, the read-only-checkpoint
paragraph, and the two "the rfc-000N tag will mark it" promises are gone.

Tags deleted locally, recreatable from these commits if ever wanted:

  phase-0   8775267  Phase 0: repo restructure, CI, baseline hardening (#143)
  phase-1   99d458a  Phase 1: three-layer monitoring, canary v1 (#159)
  phase-2   23170c3  Phase 2: contract-first gRPC + OpenTelemetry (#162)
  phase-3   a8ccbc0  Phase 3: Go analytics, pipeline-lag canary v2 (#167)
  phase-4   ec4810b  Phase 4: load profile, Alertmanager, e2e gate (#172)
  phase-5   9cb1b1f  Phase 5: historical seeder, workshop mode (#175)
  phase-6   393989a  Phase 6: Kotlin reports, report load, canary v3 (#180)
  rfc-0002  e4bbafc  RFC-0002: reports-ui Caddy static SPA (#182)

All eight are ancestors of main, so the commits stay reachable regardless.
@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 7d841b1f-9ed0-4a7c-83d1-085238b89446

📥 Commits

Reviewing files that changed from the base of the PR and between 4fd81cd and 3180604.

📒 Files selected for processing (1)
  • docs/course.md

Walkthrough

The course documentation removes phase-tag browsing guidance, simplifies the course map, removes obsolete module tag references, and directs readers to main, RFC-0001, ADRs, and PRs for platform history.

Changes

Course documentation guidance

Layer / File(s) Summary
Course reading and history guidance
docs/course.md
Course usage and mapping instructions now use main as the source of truth, module status text no longer names phase tags, and platform history guidance uses git log --oneline with RFC-0001 sections and ADRs.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • vovinacci/devops-demo#184: Updates the same course guidance with a phase-tag workflow that this change subsequently removes.

Poem

I hopped through the docs with a cheerful thump,
Tags tucked away in a history lump.
Main now shines as the guiding light,
RFCs and ADRs make the path bright.
Binky, the course map’s clear tonight!

🚥 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 The title accurately reflects removing phase tags and the tag-based workflow from the course docs.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/drop-phase-tags

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.

@vovinacci

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@vovinacci

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 27, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@vovinacci
vovinacci merged commit 5059f76 into main Jul 27, 2026
7 checks passed
@vovinacci
vovinacci deleted the docs/drop-phase-tags branch July 27, 2026 19: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