You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace prerelease-link-subdomain with version-aware shortcode
The `prerelease-link-subdomain` variable is phase-aware but not
version-aware — on the next RC cycle, old blog posts would incorrectly
point to prerelease.quarto.org even though those docs already moved
to quarto.org.
Add a `prerelease-docs-url` shortcode extension that compares a
version argument against the `version` key in `_quarto.yml` to decide
whether docs live on quarto.org or prerelease.quarto.org. On the
prerelease site (prerelease-docs profile), it always returns
"prerelease." regardless of version.
Follow-up to quarto-dev#1932, relates to quarto-dev#1934.
Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,24 +132,25 @@ The group order determines which phase is active on **quarto.org** (the main sit
132
132
|---|---|
133
133
| `_quarto-prerelease-docs.yml` | Site-specific configuration for prerelease.quarto.org |
134
134
135
-
### Subdomain variables
135
+
### Subdomain variable and shortcode
136
136
137
-
Two variables control how links resolve across builds. Both use the same pattern — `https://{{< meta VAR >}}quarto.org/...` — but serve different purposes:
137
+
**`prerelease-subdomain`** — site identity variable ("am I the prerelease site?"). Default `''` in `_quarto.yml`, set to `prerelease.` in `_quarto-prerelease-docs.yml`. Use for self-referential links (e.g. RevealJS demo links back to its own site).
138
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.` |
139
+
**`prerelease-docs-url`** — version-aware shortcode for content linking. Use in blog posts that reference docs only available on prerelease:
143
140
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).
The shortcode compares its version argument to the `version` key in `_quarto.yml` (which tracks the current stable release on `main`). If they match, docs are on quarto.org (`""`); if not, they're still on prerelease.quarto.org (`"prerelease."`). On the prerelease site (`prerelease-docs` profile), it always returns `"prerelease."`.
145
146
146
147
### Release lifecycle
147
148
148
149
1. **Development phase:** group is `[prerelease, rc]` — main site shows "Pre-release"
149
150
2. **RC phase:** flip group to `[rc, prerelease]` — main site shows "Release Candidate"
150
151
3. **Release:** flip back to `[prerelease, rc]` for the next development cycle
151
152
152
-
These flips only affect quarto.org. The prerelease site CI explicitly activates `prerelease,prerelease-docs`, so it always shows "Pre-release" regardless of group order.
153
+
These flips only affect quarto.org. The prerelease site CI activates `prerelease-docs`, and the group order determines the phase branding on the prerelease site too.
Copy file name to clipboardExpand all lines: _quarto-prerelease-docs.yml
+2-3Lines changed: 2 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
# Pre-release version number
2
-
version: v1.9
2
+
version: '1.9'
3
3
4
4
prerelease-subdomain: prerelease.
5
-
prerelease-link-subdomain: prerelease.
6
5
7
6
website:
8
7
title: "Quarto (Pre-release)"
@@ -11,7 +10,7 @@ website:
11
10
repo-branch: prerelease
12
11
announcement:
13
12
dismissable: false
14
-
content: "Pre-release ({{< meta version >}}) Documentation: [Download {{< meta version >}}](/docs/download/prerelease.qmd), [Current Release Docs](http://quarto.org) "
13
+
content: "Pre-release (v{{< meta version >}}) Documentation: [Download v{{< meta version >}}](/docs/download/prerelease.qmd), [Current Release Docs](http://quarto.org) "
0 commit comments