Skip to content

chore(docs): switch documentation deployment target#9905

Open
grega wants to merge 3 commits into
RaspberryPiFoundation:mainfrom
grega:chore/switch-docs-deployment-target
Open

chore(docs): switch documentation deployment target#9905
grega wants to merge 3 commits into
RaspberryPiFoundation:mainfrom
grega:chore/switch-docs-deployment-target

Conversation

@grega
Copy link
Copy Markdown
Member

@grega grega commented May 20, 2026

The basics

The details

Proposed Changes

Switches documentation deployment target from GitHub Pages to Cloudflare Pages.

Preview build: https://blockly-docs.pages.dev

Reason for Changes

Ensures that the existing GH Pages workflow can continue to run without needing modification (ie. without needing to figure out how to deploy both sets of assets to GH Pages without overwriting each other).

Prior to running this workflow for the first time, two secrets will need adding to this repository:

  • CLOUDFLARE_ACCOUNT_ID
  • CLOUDFLARE_API_TOKEN

I can provide values for each.

@grega grega requested a review from a team as a code owner May 20, 2026 09:44
@grega grega requested a review from lizschwab May 20, 2026 09:44
@grega grega changed the title Chore/switch docs deployment target chore(docs): switch docs deployment target May 20, 2026
@grega grega changed the title chore(docs): switch docs deployment target chore(docs): switch documentation deployment target May 20, 2026
@github-actions github-actions Bot added PR: chore General chores (dependencies, typos, etc) and removed PR: chore General chores (dependencies, typos, etc) labels May 20, 2026
@grega
Copy link
Copy Markdown
Member Author

grega commented May 20, 2026

@maribethb has the context here @lizschwab, so feel free to pass on the review if you prefer!

@grega grega force-pushed the chore/switch-docs-deployment-target branch from 68f5492 to f4b45f9 Compare May 20, 2026 09:55
@github-actions github-actions Bot added PR: chore General chores (dependencies, typos, etc) and removed PR: chore General chores (dependencies, typos, etc) labels May 20, 2026

# Strip .md/.mdx extensions if someone lands on the raw filename
/reference/*.md /reference/:splat 302
/reference/*.mdx /reference/:splat 302
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I used 302 throughout as I'm generally hesitant about applying truly permanent redirects with 301 (not that all user-agents necessarily stick to the spec here, though some will certainly cache it with no expiry).

That said, the .md and .mdx redirects feel in particular like a 301 would be fine.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think 301 is probably fine, but I'm happy to make sure everything is set up correctly before we start claiming that our redirects are permanent!

@maribethb maribethb self-requested a review May 20, 2026 18:48
@maribethb maribethb self-assigned this May 20, 2026

# Strip .md/.mdx extensions if someone lands on the raw filename
/reference/*.md /reference/:splat 302
/reference/*.mdx /reference/:splat 302
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think 301 is probably fine, but I'm happy to make sure everything is set up correctly before we start claiming that our redirects are permanent!

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

Labels

PR: chore General chores (dependencies, typos, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants