Skip to content

Move the deployer docs into the doc-site - #12327

Merged
nbudin merged 1 commit into
mainfrom
12260-deploy-docs-to-doc-site
Oct 30, 2026
Merged

nbudin merged 1 commit into
mainfrom
12260-deploy-docs-to-doc-site

Conversation

@nbudin

@nbudin nbudin commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Purpose

The deployer docs (deploy/README.md and 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 to doc-site/docs/deploying under a new "Deploying Intercode" sidebar category. The docker-compose example and example.env move to doc-site/static/deploying so the pages can link to them as downloads.

The references in the README, the nginx front proxy files, the assets Dockerfile and the cloudfront_intercode README now point at the published pages.

Changes

💻 Engineer-facing

  • deploy/ is gone; its files are renames, so history follows them.
  • Links inside the moved pages that used to be relative paths into the repo (the Terraform modules, the logging module) are now absolute GitHub URLs, since the doc site can't resolve them.
  • I rebased onto main and resolved one conflict in staged-rollout.md: Let assets_bucket_intercode trust every CloudFront distribution in the account #12325 reworded the bucket policy bullet in the old deploy/staged-rollout.md, and this branch had rewritten the same bullet's link. The result keeps the new wording (set allow_account_cloudfront_distributions or list the distribution) with the absolute link.

Testing

yarn build in doc-site succeeds and compiles the new pages. It does print a broken-anchor warning for /docs/concepts/events-and-runs linking to signups#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

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 nbudin added patch Bumps the patch version number on release documentation labels Oct 30, 2026
@nbudin
nbudin marked this pull request as ready for review October 30, 2026 19:18
@github-actions

Copy link
Copy Markdown
Contributor

Code Coverage Report: Only Changed Files listed

Package Base Coverage New Coverage Difference
app/graphql/concerns/cms_parent_implementation.rb 🔴 45.95% 🔴 43.24% 🔴 -2.71%
app/javascript/setupI18Next.ts 🟢 82.76% 🟢 89.66% 🟢 6.9%
Overall Coverage 🟢 67.35% 🟢 67.35% ⚪ 0%

Minimum allowed coverage is 0%, this run produced 67.35%

@nbudin
nbudin merged commit c9ea34c into main Oct 30, 2026
26 checks passed
@nbudin
nbudin deleted the 12260-deploy-docs-to-doc-site branch October 30, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation patch Bumps the patch version number on release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant