docs: document deployment structure - #8
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f1147ec852
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Operationally, "deploying" this project means publishing or installing the package and validating stream operator actions against the live 555stream control plane. Use `docs/PUBLISHING.md`, `docs/PUBLIC_RELEASE_CHECKLIST.md`, and the docs listed below for release readiness. | ||
|
|
||
| The local-only 555stream runbook at `555/internal-ops-docs/deploy/DEPLOY_GIT_AUTH_RUNBOOK.md` documents the production 555stream host Git-auth recovery path. This plugin should reference that runbook only for operator context; it does not own the stream-host deployment itself. |
There was a problem hiding this comment.
This line points readers to 555/internal-ops-docs/deploy/DEPLOY_GIT_AUTH_RUNBOOK.md, but that file is not present in this repository (I checked with rg --files | rg 'DEPLOY_GIT_AUTH_RUNBOOK.md|internal-ops-docs' and only this README reference exists). Because the path is written as an in-repo location, operators following deployment guidance will hit a dead end, which undermines the new “Deployment structure” documentation.
Useful? React with 👍 / 👎.
1 participant
Adds README deployment structure details for this repo. Clarifies the current deployment model and points teams at the deployment runbook. Validation: clean worktree patch application, git diff --check, and secret-pattern scan across touched README files.