Skip to content

Publish Q2 docs at quarto-dev.github.io/q2; retire old sandbox deploy - #929

Merged
cscheid merged 1 commit into
mainfrom
feature/bd-73lilznv-docs-pages
Oct 27, 2026
Merged

cscheid merged 1 commit into
mainfrom
feature/bd-73lilznv-docs-pages

Conversation

@cscheid

@cscheid cscheid commented Oct 27, 2026

Copy link
Copy Markdown
Member

Phase 4 of bd-73lilznv (plan: claude-notes/plans/2026-10-26-move-sandbox-free-q2-pages.md). #919 moved the sandboxed preview to https://quarto-dev.github.io/q2-sandbox/, and production quarto-hub.com has been running against it since 2026-10-26, so /q2/ is now free.

  • Delete deploy-sandboxed-preview.yml, the transitional copy of the sandbox at /q2/.
  • Add deploy-docs.yml. It builds q2 from source, runs cargo xtask stage-doc-examples and q2 render docs, then deploys docs/_site via upload-pages-artifact and deploy-pages to the github-pages environment. It deploys on pushes to main that touch docs/ or examples/, or on workflow_dispatch. PRs touching those paths run the build job only. This PR is one of them, so its CI exercises the build.
  • Add docs/serviceWorker.js, listed under project.resources. The old sandbox service worker answers page loads under /q2/ with an error when it isn't framed. For any browser that still has it registered, this kill switch replaces it on the next visit, unregisters itself and reloads the page. It can be removed no earlier than about 2027-04.
  • Update github-pages.md, the sandbox README and the plan's progress log.

Verification (local)

  • q2 render docs: 391/391 pages; serviceWorker.js lands at the site root.
  • A link check of the site served under /q2/ found only problems that are already broken at any base path: missing figure images on guides/authoring/{figures,brand} and links to Q1 /docs/... pages.
  • Kill-switch test in an isolated Chrome profile. I registered the old sandbox worker at /q2/, then swapped in the docs build and visited a docs subpage. The first load showed the old "VFS proxy timeout" error. The kill switch then installed, unregistered itself and reloaded the page into the real docs page, with no controller and 0 registrations.
  • q2 render --strict claude-notes is clean.

Merging triggers the first docs deploy to https://quarto-dev.github.io/q2/.

🤖 Generated with Claude Code

… deploy

Phase 4 of bd-73lilznv. Production quarto-hub.com now loads the sandboxed
preview from /q2-sandbox/, so /q2/ is free:

- Delete deploy-sandboxed-preview.yml (the transitional copy at /q2/).
- Add deploy-docs.yml: build q2 from source, stage the example projects,
  `q2 render docs`, and deploy docs/_site to this repo's Pages site. PRs
  touching docs/ or examples/ run the build job only.
- Add docs/serviceWorker.js (a project resource), a kill switch that
  replaces the old sandbox service worker for anyone who still has it
  registered at /q2/, then unregisters itself and reloads the page.
- Update github-pages.md, the sandbox README and the plan.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@posit-snyk-bot

posit-snyk-bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

✅ Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
✅ Open Source Security 0 0 0 0 0 issues
✅ Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@cscheid
cscheid merged commit b3302a1 into main Oct 27, 2026
14 checks passed
@cscheid
cscheid deleted the feature/bd-73lilznv-docs-pages branch October 27, 2026 14:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants