Skip to content

Docs: add Cloudflare post-deploy runbook#1106

Open
richardjoo wants to merge 2 commits into
emdash-cms:mainfrom
richardjoo:split/docs-cloudflare-runbook
Open

Docs: add Cloudflare post-deploy runbook#1106
richardjoo wants to merge 2 commits into
emdash-cms:mainfrom
richardjoo:split/docs-cloudflare-runbook

Conversation

@richardjoo
Copy link
Copy Markdown
Contributor

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

  • Bug fix
  • Feature (requires maintainer-approved Discussion)
  • Refactor (no behavior change)
  • Translation
  • Documentation
  • Performance improvement
  • Tests
  • Chore (dependencies, CI, tooling)

Checklist

  • I have read CONTRIBUTING.md
  • pnpm typecheck passes
  • pnpm lint passes
  • pnpm test passes (or targeted tests for my change)
  • pnpm format has been run
  • I have added/updated tests for my changes (if applicable)
  • User-visible strings in the admin UI are wrapped for translation (if applicable). Do not include messages.po changes except in translation PRs — a workflow extracts catalogs on merge to main.
  • I have added a changeset (if this PR changes a published package)
  • New features link to an approved Discussion: https://github.com/emdash-cms/emdash/discussions/...

AI-generated code disclosure

  • This PR includes AI-generated code — model/tool: GPT-5.4 / OpenCode

Screenshots / test output

  • prettier --check on changed docs files

Copilot AI review requested due to automatic review settings May 19, 2026 19:08
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 19, 2026

⚠️ No Changeset found

Latest commit: 699d15e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

Comment on lines +20 to +24
## 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
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants