docs: rewrite README as portfolio-facing IDP overview #240

Merged

forgejo_admin merged 2 commits from 239-readme-portfolio-polish into main

2026-03-28 22:13:47 +00:00

Conversation 1 Commits 2 Files changed 1 +50 -100

forgejo_admin commented

2026-03-28 22:10:04 +00:00

Contributor

Copy link

Summary

Replaces the internal bootstrap-focused README with a portfolio-ready presentation. A recruiter or hiring manager landing on this repo immediately sees what the platform does, how it is architected, and what decisions were made.

Changes

README.md -- Complete rewrite. 127 lines replaced with 76. Removed internal operational details (secrets how-to, GPG key IDs, adding-a-secret checklist) and replaced with architecture table, GitOps pipeline diagram, design decision rationale, and related repo links.

Test Plan

Verify rendered markdown on Forgejo looks correct (tables, code blocks, ASCII diagrams)
Confirm line count is under 80
Confirm no secrets or internal URLs leaked (all links point to Forgejo instance)

Review Checklist

README is under 80 lines (76)
No secrets, GPG key IDs, or credentials in the new content
All 10 modules accurately listed with correct descriptions
GitOps pipeline diagram matches actual flow
Related repo links are valid Forgejo URLs

Related Notes

None -- standalone documentation change.

Closes #239

## Summary Replaces the internal bootstrap-focused README with a portfolio-ready presentation. A recruiter or hiring manager landing on this repo immediately sees what the platform does, how it is architected, and what decisions were made. ## Changes - `README.md` -- Complete rewrite. 127 lines replaced with 76. Removed internal operational details (secrets how-to, GPG key IDs, adding-a-secret checklist) and replaced with architecture table, GitOps pipeline diagram, design decision rationale, and related repo links. ## Test Plan - Verify rendered markdown on Forgejo looks correct (tables, code blocks, ASCII diagrams) - Confirm line count is under 80 - Confirm no secrets or internal URLs leaked (all links point to Forgejo instance) ## Review Checklist - [x] README is under 80 lines (76) - [x] No secrets, GPG key IDs, or credentials in the new content - [x] All 10 modules accurately listed with correct descriptions - [x] GitOps pipeline diagram matches actual flow - [x] Related repo links are valid Forgejo URLs ## Related Notes None -- standalone documentation change. ## Related Closes #239

forgejo_admin added 1 commit

2026-03-28 22:10:04 +00:00

docs: rewrite README as portfolio-facing IDP overview

All checks were successful

ci/woodpecker/push/woodpecker Pipeline was successful

Details

ci/woodpecker/pr/woodpecker Pipeline was successful

Details

fbfbd6968e

Replaces internal bootstrap-focused README with a recruiter-ready
presentation. Leads with architecture (10 OpenTofu modules), GitOps
pipeline, Tailscale mesh networking, and DORA observability. Under 80 lines.

Closes #239

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

forgejo_admin added 1 commit

2026-03-28 22:11:31 +00:00

fix: correct funnel count to 8, use GitHub links for portfolio access

All checks were successful

ci/woodpecker/push/woodpecker Pipeline was successful

Details

ci/woodpecker/pr/woodpecker Pipeline was successful

Details

ci/woodpecker/pull_request_closed/woodpecker Pipeline was successful

Details

6925f315ad

Review found two issues:
- networking module has 8 ingress funnels, not 9
- Forgejo tailnet URLs are unreachable by recruiters; switched to GitHub mirrors

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

forgejo_admin commented

2026-03-28 22:11:47 +00:00

Author

Contributor

Copy link

QA Review

Scope: README.md rewrite -- docs only, no infrastructure changes.

Findings (fixed in `6925f31`)

Inaccurate funnel count. README claimed "9 ingress funnels" but terraform/modules/networking/main.tf defines exactly 8: grafana, alertmanager, forgejo, woodpecker, harbor, minio, minio-api, keycloak. Fixed to 8.
Unreachable links for recruiters. All Related Repositories and the GitOps Pipeline section linked to forgejo.tail5b443a.ts.net -- a private Tailscale hostname. A recruiter viewing this portfolio README cannot resolve those URLs. Switched to github.com/ldraney/* mirrors.

Verified

10 modules match actual terraform/modules/ directory (ci, database, forgejo, harbor, keycloak, monitoring, networking, ops, staging, storage)
11 Helm releases accurately represented across module descriptions
4 Grafana dashboards match terraform/dashboards/ contents
15 secrets count matches existing README documentation
GitOps pipeline flow (Woodpecker -> Harbor -> ArgoCD -> k3s) is accurate
No secrets, GPG key IDs, or credentials in the new content
Line count: 76 (under 80 limit)
Salt pillar/states directory structure accurately described

No issues remaining.

VERDICT: APPROVED

## QA Review **Scope:** README.md rewrite -- docs only, no infrastructure changes. ### Findings (fixed in 6925f31) 1. **Inaccurate funnel count.** README claimed "9 ingress funnels" but `terraform/modules/networking/main.tf` defines exactly 8: grafana, alertmanager, forgejo, woodpecker, harbor, minio, minio-api, keycloak. Fixed to 8. 2. **Unreachable links for recruiters.** All Related Repositories and the GitOps Pipeline section linked to `forgejo.tail5b443a.ts.net` -- a private Tailscale hostname. A recruiter viewing this portfolio README cannot resolve those URLs. Switched to `github.com/ldraney/*` mirrors. ### Verified - [x] 10 modules match actual `terraform/modules/` directory (ci, database, forgejo, harbor, keycloak, monitoring, networking, ops, staging, storage) - [x] 11 Helm releases accurately represented across module descriptions - [x] 4 Grafana dashboards match `terraform/dashboards/` contents - [x] 15 secrets count matches existing README documentation - [x] GitOps pipeline flow (Woodpecker -> Harbor -> ArgoCD -> k3s) is accurate - [x] No secrets, GPG key IDs, or credentials in the new content - [x] Line count: 76 (under 80 limit) - [x] Salt pillar/states directory structure accurately described ### No issues remaining. **VERDICT: APPROVED**

forgejo_admin merged commit 4c521d5da0 into main

2026-03-28 22:13:47 +00:00

forgejo_admin deleted branch 239-readme-portfolio-polish

2026-03-28 22:13:47 +00:00

forgejo_admin referenced this pull request from a commit

2026-03-28 22:13:47 +00:00

docs: rewrite README as portfolio-facing IDP overview (#240)

forgejo_admin referenced this pull request

2026-03-28 23:23:40 +00:00

Python repo standards: ruff pre-commit hooks + repo setup template #29

Reviewers

No reviewers

Labels

Clear labels

QA passed, awaiting merge approval

status:in-progress

Dev agent is actively working

status:needs-fix

QA found issues, back to dev

status:qa

PR submitted, awaiting QA review

type:bug

Bug fix

type:devops

Infrastructure/CI/config work

No labels

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

ldraney/pal-e-platform!240

Reference in a new issue

Repository

ldraney/pal-e-platform

Title

Body

No description provided.

Delete branch "239-readme-portfolio-polish"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?

Rows
Columns