Repository navigation
Move the deployer docs into the doc-site - #12327
Merged
Merged
Conversation
deploy/README.md and deploy/staged-rollout.md become pages under doc-site/docs/deploying, with a "Deploying Intercode" sidebar category, and the docker-compose example and example.env move to doc-site/static/deploying so the pages can link to them. References in the README, the nginx front proxy files, the Dockerfile and the cloudfront_intercode README now point at the published pages. Part of #12260. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UKBUsvK2TxyNpBVBi531xz
nbudin
marked this pull request as ready for review
October 30, 2026 19:18
Contributor
Code Coverage Report: Only Changed Files listed
Minimum allowed coverage is |
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.
Purpose
The deployer docs (
deploy/README.mdand the staged rollout runbook) read better as part of the doc site than as markdown files in the repo root, and the doc site is where people look for how to run Intercode. This moves them todoc-site/docs/deployingunder a new "Deploying Intercode" sidebar category. The docker-compose example andexample.envmove todoc-site/static/deployingso the pages can link to them as downloads.The references in the README, the nginx front proxy files, the assets Dockerfile and the
cloudfront_intercodeREADME now point at the published pages.Changes
💻 Engineer-facing
deploy/is gone; its files are renames, so history follows them.mainand resolved one conflict instaged-rollout.md: Let assets_bucket_intercode trust every CloudFront distribution in the account #12325 reworded the bucket policy bullet in the olddeploy/staged-rollout.md, and this branch had rewritten the same bullet's link. The result keeps the new wording (setallow_account_cloudfront_distributionsor list the distribution) with the absolute link.Testing
yarn buildindoc-sitesucceeds and compiles the new pages. It does print a broken-anchor warning for/docs/concepts/events-and-runslinking tosignups#registration-policies; that page isn't touched here. I haven't looked at the rendered pages in a browser or checked the published URLs, which won't exist until this deploys.Release plan and notes
The in-repo references point at
https://intercode.interactiveliterature.org/docs/deploying, so they'll be dead links until the doc site deploys this. Part of #12260.🚢
🤖 Generated with Claude Code