Skip to content

Commit 09f596b

Browse files
committed
Add prerelease-link-subdomain for phase-aware linking to prerelease docs
Blog posts on main need to link to prerelease.quarto.org during RC phase (when docs only exist there) and switch to quarto.org after release. Unlike prerelease-subdomain (site identity), this variable is phase-aware: - Default: '' (links to quarto.org) - RC profile: 'prerelease.' (docs still on prerelease site) - prerelease-docs profile: 'prerelease.' (prerelease site links to itself)
1 parent e5bccfa commit 09f596b

4 files changed

Lines changed: 14 additions & 2 deletions

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,16 @@ The group order determines which phase is active on **quarto.org** (the main sit
132132
|---|---|
133133
| `_quarto-prerelease-docs.yml` | Site-specific configuration for prerelease.quarto.org |
134134

135-
The `prerelease-subdomain` variable is defined as empty (`''`) in `_quarto.yml` (so links point to `quarto.org` by default) and overridden to `prerelease.` only in `_quarto-prerelease-docs.yml`.
135+
### Subdomain variables
136+
137+
Two variables control how links resolve across builds. Both use the same pattern — `https://{{< meta VAR >}}quarto.org/...` — but serve different purposes:
138+
139+
| Variable | Purpose | Default | Set by `rc` | Set by `prerelease-docs` |
140+
|---|---|---|---|---|
141+
| `prerelease-subdomain` | **Site identity** — "am I the prerelease site?" | `''` | — | `prerelease.` |
142+
| `prerelease-link-subdomain` | **Content linking** — "where do prerelease docs live right now?" | `''` | `prerelease.` | `prerelease.` |
143+
144+
Use `prerelease-subdomain` for self-referential links (e.g. RevealJS demo links back to its own site). Use `prerelease-link-subdomain` for content on `main` that references docs only available on prerelease during RC phase (e.g. blog posts announcing upcoming features).
136145

137146
### Release lifecycle
138147

_quarto-prerelease-docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
version: v1.9
33

44
prerelease-subdomain: prerelease.
5+
prerelease-link-subdomain: prerelease.
56

67
website:
78
title: "Quarto (Pre-release)"

_quarto-rc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
prerelease-title: Release Candidate
22
prerelease-lower: release candidate
3-
prerelease-mode: Release Candidate
3+
prerelease-mode: Release Candidate
4+
prerelease-link-subdomain: prerelease.

_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,6 +707,7 @@ filters:
707707
path: filters/include-dark.lua
708708

709709
prerelease-subdomain: ''
710+
prerelease-link-subdomain: ''
710711

711712
freeze: true
712713

0 commit comments

Comments
 (0)