Docs: add Cloudflare post-deploy runbook#1106
Conversation
|
There was a problem hiding this comment.
Pull request overview
Adds Cloudflare post-deploy operational documentation and links it into the docs navigation and related deployment/API pages.
Changes:
- Adds a new runbooks index and Cloudflare post-deploy operations runbook.
- Adds Runbooks to the Starlight sidebar.
- Links the Cloudflare runbook from deployment and REST API docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/runbooks/index.mdx |
Introduces the runbooks landing page. |
docs/src/content/docs/runbooks/deployment/cloudflare-post-deploy-operations.mdx |
Adds the Cloudflare post-deploy checklist. |
docs/src/content/docs/reference/rest-api.mdx |
Adds a cross-link to the Cloudflare runbook. |
docs/src/content/docs/deployment/cloudflare.mdx |
Documents API-based management after Cloudflare deploy. |
docs/astro.config.mjs |
Adds Runbooks entries to the docs sidebar. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| A good first scope set for a publishing script is: | ||
|
|
There was a problem hiding this comment.
You’re right that the baseline token guidance was inconsistent with the next verification step.
I’ve updated the runbook to include content:read alongside content:write and media:write, so the subsequent GET /_emdash/api/content/posts check matches the recommended token scope set.
| ## Response format | ||
|
|
||
| For post-deploy operational checks that separate EmDash API usage from Cloudflare platform tasks, see [Cloudflare Post-Deploy Operations](/runbooks/deployment/cloudflare-post-deploy-operations). | ||
|
|
||
| ## Response Format |
There was a problem hiding this comment.
Agreed. I moved the Cloudflare post-deploy runbook link up under the Authentication section and removed the duplicated response-format heading so the section structure stays:
- Authentication
- Response format
That keeps the cross-link in a more appropriate place and avoids the duplicated heading.
What does this PR do?
Adds a Cloudflare post-deploy runbook and links it from the Cloudflare deployment and REST API docs.
Closes #
Type of change
Checklist
pnpm typecheckpassespnpm lintpassespnpm testpasses (or targeted tests for my change)pnpm formathas been runmessages.pochanges except in translation PRs — a workflow extracts catalogs on merge tomain.AI-generated code disclosure
Screenshots / test output
prettier --checkon changed docs files