Skip to content

docs: fix Get Started and ensure-flow based on integrator feedback#196

Open
stevenolen wants to merge 1 commit intomainfrom
docs-integrator-feedback
Open

docs: fix Get Started and ensure-flow based on integrator feedback#196
stevenolen wants to merge 1 commit intomainfrom
docs-integrator-feedback

Conversation

@stevenolen
Copy link
Copy Markdown
Collaborator

Description

Fixes five documentation issues reported by an integrator testing PTD on AWS EKS.

Code Flow

N/A — documentation-only changes.

Category of change

  • Documentation: documentation changes

Changes

  • Fix build command: just build-cmdjust cli in GETTING_STARTED.md and PTD_CLI_REFERENCE.md Development section
  • Reconcile control room step count: Removed incorrect bootstrap step from control room steps in PTD_CLI_REFERENCE.md (code only registers bootstrap for workloads, not control rooms)
  • Clarify bootstrap requirement: Added warning in ensure-flow.md that bootstrap must complete before later steps run (creates S3 bucket / storage account for Pulumi state), and that -v surfaces expected resource names on failure
  • Document IAM permissions: Added section in PTD_CLI_REFERENCE.md explaining admin.posit.team role setup via ptd admin generate-role, self-constraining policy guardrails, and custom_role escape hatch
  • Add AWS prerequisites: Added Route 53 hosted zone and admin.posit.team IAM role as explicit prerequisites in the Get Started guide

Checklist

  • I have reviewed my own diff and added inline comments on lines I want reviewers to focus on or that I am uncertain about

- Fix CLI build command: `just build-cmd` → `just cli` (GETTING_STARTED.md, PTD_CLI_REFERENCE.md)
- Remove incorrect bootstrap step from control room step list in PTD_CLI_REFERENCE.md (control rooms don't have bootstrap, only workloads do)
- Add bootstrap prerequisite warning in ensure-flow.md explaining that the state backend must exist before later steps can run, and how to use -v to diagnose missing bucket errors
- Add IAM permissions section documenting admin.posit.team role setup, self-constraining policy, and custom_role alternative
- Add Route 53 hosted zone and admin.posit.team role as explicit AWS prerequisites in Get Started guide
@stevenolen stevenolen marked this pull request as ready for review April 3, 2026 16:06
@stevenolen stevenolen requested a review from a team as a code owner April 3, 2026 16:06
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