docs: add operations + rotation playbooks, recipes, limits, API toolkit - #10
Merged
Conversation
Expands the docs/ layer from "what this is" to "how to run it" with
seven additions / extensions, plus an index so the surface stays
navigable as it grows.
Added:
- docs/rollback.md — six ranked options when apply goes
wrong: revert, discard, cancel,
state surgery, admin override, rebuild.
- docs/recipes.md — copy-paste recipes for the five
tasks future-you will do most: add
DNS record, add repo, add label, bump
provider, cross-workspace change.
- docs/limits.md — free-tier ceilings on HCP, Cloudflare,
GitHub, Let's Encrypt with current
usage and the cliffs to watch.
- docs/hcp-api.md — REST API toolkit: workspace lookup,
plan summary, confirm/discard/cancel,
variable listing, manual plan trigger.
Every script we used during the
bootstrap, generalised and reusable.
- docs/worktree-workflow.md — optional git worktree convention
for maintainers juggling branches.
- docs/README.md — index of every doc with a one-line
hook and a reading order for first
contact. Stops the docs surface from
becoming a flat directory listing.
Extended:
- docs/secrets.md — Rotation section turned from
one-line-per-credential into step-by-
step zero-downtime procedures with
"no plan, no revoke" verification.
- terraform/README.md — Conventions section: lock file is
committed, label naming, file-per-
category split, provider pin policy
(~> X.Y), cross-leaf references hedge.
Pairs with #9 (CONTRIBUTING.md) and Issue #8 (HCP-as-code) so the
next session can pick up either thread with full operational
context, not just first-contact orientation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands the docs/ layer from "what this is" to "how to run it" with seven additions and an index. The big swing is moving from first-contact orientation (covered by #9) into operational reference: when something breaks, when something needs adding, when a token rotates, what each vendor limit is, and how to drive HCP from CLI.
What's new
docs/rollback.mddocs/recipes.mddocs/limits.mddocs/hcp-api.mddocs/worktree-workflow.mddocs/README.mdWhat's extended
Test plan
Pairs with
After this lands, the docs/ surface is opinionated, indexed, and operationally complete enough that the next agent can pick up issue #8 cold with full context.