Skip to content
This repository was archived by the owner on May 8, 2026. It is now read-only.

docs: update README for in-cluster dev#10

Merged
rowan-stein merged 2 commits intomainfrom
noa/issue-9
Mar 13, 2026
Merged

docs: update README for in-cluster dev#10
rowan-stein merged 2 commits intomainfrom
noa/issue-9

Conversation

@casey-brooks
Copy link
Copy Markdown
Contributor

Summary

  • replace local development instructions with in-cluster DevSpace workflow
  • document prerequisites, cluster setup, testing, and troubleshooting

Testing

  • pnpm lint
  • pnpm test

Closes #9

@casey-brooks
Copy link
Copy Markdown
Contributor Author

Summary

  • replaced local development instructions with the in-cluster DevSpace workflow
  • added cluster setup, testing steps, and troubleshooting guidance

Testing

  • pnpm lint
  • pnpm test

Lint

  • eslint . (no errors)

Copy link
Copy Markdown

@noa-lucent noa-lucent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good structure overall — the README covers all the right sections and reads well. One blocking issue: the terraform.tfvars copy path is incorrect (no terraform/ directory exists in bootstrap_v2; the actual path is stacks/platform/). Three smaller items to bring the content in line with the issue spec: missing prerequisites, missing verification step, and missing DinD context for integration tests.

Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
@casey-brooks
Copy link
Copy Markdown
Contributor Author

Summary

  • corrected bootstrap tfvars path and added verification command
  • expanded prerequisites into a versioned tools table
  • clarified integration test Docker requirement

Testing

  • pnpm lint
  • pnpm test

Lint

  • eslint . (no errors)

Copy link
Copy Markdown

@noa-lucent noa-lucent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All four prior comments verified in code and resolved:

  1. ✅ tfvars path corrected to stacks/platform/terraform.tfvars.example
  2. ✅ Prerequisites table now includes all five tools (Docker, k3d, Terraform, kubectl, DevSpace)
  3. ✅ Verification step (kubectl get deployment) added to Cluster Setup
  4. ✅ DinD sidecar context added to Running Tests section

README now fully matches the issue #9 spec. LGTM.

@rowan-stein rowan-stein merged commit 460debf into main Mar 13, 2026
1 check passed
@casey-brooks casey-brooks deleted the noa/issue-9 branch March 13, 2026 18:33
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite development README for in-cluster workflow

3 participants