adam/engineering-handbook
1
0
Fork 0
mirror of https://github.com/Sea-Haven-Industries/engineering-handbook.git synced 2026-10-02 12:03:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
engineering-handbook/confluence/README.md

35 lines
2.1 KiB
Markdown
Raw Normal View History

docs(confluence): add sanitized standards export for partner teams Partner engineering teams need the standards without access to this repo, which contains internal repo names, account identifiers, and migration history. Adds eight simplified pages, one per Confluence page, plus an internal README with source mapping and exclusions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UP6j3hYgoVqjKZwC3XB9ay
2026-09-27 01:58:05 +00:00
# Confluence Export: External Standards
A simplified, sanitized copy of this handbook for partner and contract engineering teams. Each numbered file is one Confluence page, and its H1 is the page title. Publish `00-engineering-standards.md` as the parent page and the rest as its children, in number order.
This README is internal. Do not publish it.
## Rules for these pages
- Link between pages by page title, not by file path. Repo-relative links break in Confluence.
- No internal repo names, AWS account names or IDs, IAM role or trust details, org secret names, Jira ticket numbers, people's names, or incident history.
- State the current standard only. No migration history, legacy lanes, or one-off exceptions.
- When a root handbook page changes a rule, update the matching page here in the same PR.
## Source mapping
| Page | Handbook source |
|---|---|
| `00-engineering-standards.md` | `README.md` |
| `01-naming-conventions.md` | `naming-conventions.md` |
| `02-git-workflow.md` | `git-workflow.md`, `commit-messages.md` |
| `03-pull-requests-and-code-review.md` | `pull-requests.md`, `code-review.md`, `code-review-rubric.md` |
| `04-issue-tracking.md` | `issue-tracking.md` |
| `05-secrets-and-configuration.md` | `secrets-and-config.md` |
| `06-aws-infrastructure.md` | `aws-infrastructure.md`, `terraform-project-layout.md` |
| `07-ci-cd-and-deployments.md` | `cicd.md`, `github-standards.md` |
docs(confluence): add sentry standards page Partner teams need the Sentry setup and privacy rules, which only exist in individual Jira tickets. Also syncs index wording edits already made on the published Confluence page. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UP6j3hYgoVqjKZwC3XB9ay
2026-09-27 02:23:06 +00:00
| `08-sentry.md` | Jira IP-24 and PLAT-174 (the handbook has no Sentry page) |
docs(confluence): add sanitized standards export for partner teams Partner engineering teams need the standards without access to this repo, which contains internal repo names, account identifiers, and migration history. Adds eight simplified pages, one per Confluence page, plus an internal README with source mapping and exclusions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UP6j3hYgoVqjKZwC3XB9ay
2026-09-27 01:58:05 +00:00
## Deliberately excluded
- `dev-environment.md`: personal workstation layout, macOS launchd, cleanup cadence
- `hcp-terraform.md`: workspace, exec-role, and org-baseline internals
- `sam-project-layout.md`, `cdk-project-layout.md`, `lambda-template.md`, `bedrock.md`: legacy-lane and team-specific detail
- `hooks/`, `scripts/`, `constructs/`: code containing account IDs and network ranges
- Named internal repos, legacy stack names, retired Jira projects, contractor repo names, sign-off by a named person, deploy-then-merge exception, incident references, ruleset migration state, OIDC trust claims, formatter App secrets
Reference in a new issue Copy permalink