Skip to content

Commit 9d97eed

Browse files
authored
Release v0.15.0 preparation (google#2627)
1 parent 0a4cdfa commit 9d97eed

18 files changed

Lines changed: 172 additions & 105 deletions

File tree

docsy.dev/config/_default/params.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
# status: archived # Then fetch include
88

99
tdVersion:
10-
latest: &tdLatestVers v0.14.3
11-
dev: &tdDevVers v0.15.0-dev
12-
buildId: &tdBuildId 040-over-main-7a0b370f
10+
latest: &tdLatestVers v0.15.0
11+
dev: &tdDevVers v0.15.1-dev
12+
buildId: &tdBuildId ''
1313

1414
version: *tdDevVers
1515
version_menu: *tdDevVers

docsy.dev/config/doc-rooted/params.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# cSpell:ignore pagelinks
22

33
tdVersion:
4-
latest: &tdLatestVers v0.14.3
5-
dev: &tdDevVers v0.15.0-dev
6-
buildId: &tdBuildId 040-over-main-7a0b370f
4+
latest: &tdLatestVers v0.15.0
5+
dev: &tdDevVers v0.15.1-dev
6+
buildId: &tdBuildId ''
77

88
version: &tdDocRootedVers Doc-rooted of Next
99
version_menu: *tdLatestVers

docsy.dev/config/production/params.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# cSpell:ignore pagelinks
22

33
tdVersion:
4-
latest: &tdLatestVers v0.14.3
5-
dev: &tdDevVers v0.15.0-dev
6-
buildId: &tdBuildId 040-over-main-7a0b370f
4+
latest: &tdLatestVers v0.15.0
5+
dev: &tdDevVers v0.15.1-dev
6+
buildId: &tdBuildId ''
77

88
version: *tdLatestVers
99
version_menu: *tdLatestVers

docsy.dev/content/en/blog/2025/0.13.0.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Release 0.13.0 report and upgrade guide
33
linkTitle: Release 0.13.0
44
date: 2025-11-24
55
lastmod: 2026-02-07
6+
description: >-
7+
Release report and upgrade guide for Docsy 0.13.0, covering active TOC entry
8+
tracking, alert shortcode improvements, accessibility enhancements, and
9+
section sidebar root.
610
author: >-
711
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
812
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)

docsy.dev/content/en/blog/2026/0.14.0.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Release 0.14.0 report and upgrade guide
33
linkTitle: Release 0.14.0
44
date: 2026-02-10
55
lastmod: 2026-02-17
6+
description: >-
7+
Release report and upgrade guide for Docsy 0.14.0, covering markdown alert
8+
syntax, navbar style improvements, heading aliases and in-page targets, and
9+
improved separation of project and internal SCSS files.
610
author: >-
711
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
812
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)

docsy.dev/content/en/blog/2026/0.15.0.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
22
title: Release 0.15.0 report and upgrade guide
33
linkTitle: Release 0.15.0
4-
date: 2026-04-30
5-
lastmod: 2026-04-30
4+
date: 2026-05-01
5+
lastmod: 2026-05-01
6+
description: >-
7+
Release report and upgrade guide for Docsy 0.15.0, covering agent support,
8+
doc-rooted sites, version menus, community and footer links, and card
9+
shortcode rendering.
610
author: >-
711
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
812
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)
@@ -32,8 +36,9 @@ cSpell:ignore: afdocs doc-rooted llms markdownify RenderString
3236
- Generated `llms.txt`
3337
- Markdown page output
3438
- "View Markdown" page-meta link
35-
- **[Doc-rooted sites](#doc-rooted-sites)**: documented pattern and example
36-
variant for sites whose `docs` section is published at the site root
39+
- **[Doc-rooted sites](#doc-rooted-sites)** (experimental): documented pattern
40+
and example variant for sites whose `docs` section is published at the site
41+
root
3742
- **[Version menu entries](#version-menu)**: headings, separators, per-entry
3843
page-link behavior, and kind-specific styling
3944
- **Content, shortcodes, and internationalization**:
@@ -68,7 +73,7 @@ and use your site content, including:
6873
- A _View Markdown_ page-meta link when a Markdown page alternative exists.
6974

7075
To learn more, including configuration details on how to enable agent support
71-
for your site, see [Agent support][].
76+
for your site, see [Agent support][]. This feature is [experimental][].
7277

7378
> To track the phased evolution of the agent-support feature, see [Improve
7479
> support for AI-agent doc consumption #2614][#2614].

docsy.dev/content/en/project/about/changelog.md

Lines changed: 16 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -126,20 +126,14 @@ functionality, depending on scope. Prefer narrow, focused PRs where possible.
126126
For an introduction to this release, see the [0.15.0 release report][]. For the
127127
full list of changes, see the [0.15.0][] release page.
128128

129-
[**Breaking changes**](#breaking-change):
130-
131-
- **Community and footer link paths** changed for multilingual sites; see
132-
[blog][0.15.0-blog-community-footer] ([#2580][]).
133-
- **Version menu markup and mobile visibility** changed for sites using
134-
`params.versions`; see [Version menu entries][0.15.0-blog-version-menu]
135-
([#2557][], [#2586][]).
136-
- **`card` shortcode rendering** changed for Markdown arguments; breakage risk
137-
is low. See [blog][0.15.0-blog-card].
138-
139129
**New**:
140130

141-
- **[Doc-rooted sites][0.15.0-blog-doc-rooted]**: added a documented pattern and
142-
example variant for documentation-first sites ([#2563][], [#2587][]).
131+
- **[Agent support][0.15.0-blog-agent-support]**
132+
([experimental](#experimental)): added Markdown alternate outputs, "View
133+
Markdown" links, and `llms.txt` ([#2597][], [#2601][], [#2605][], [#2606][]
134+
- **[Doc-rooted sites][0.15.0-blog-doc-rooted]**
135+
([experimental](#experimental)): added a documented pattern and example
136+
variant for documentation-first sites ([#2563][], [#2587][]).
143137
- **[Version menu entries][0.15.0-blog-version-menu]**: added support for
144138
headings, separators, per-entry page-link behavior, and kind-specific styling
145139
([#2557][], [#2586][]).
@@ -150,38 +144,29 @@ full list of changes, see the [0.15.0][] release page.
150144
- Added optional `rel` attribute values for footer `params.links` ([#2576][]);
151145
see [Community and footer links][0.15.0-blog-community-footer].
152146

147+
[**Breaking changes**](#breaking-change):
148+
149+
- **Community and footer link paths** changed for multilingual sites; see
150+
[blog][0.15.0-blog-community-footer] ([#2580][]).
151+
- **Version menu markup and mobile visibility** changed for sites using
152+
`params.versions`; see [Version menu entries][0.15.0-blog-version-menu]
153+
([#2557][], [#2586][]).
154+
- **`card` shortcode rendering** changed for Markdown arguments; breakage risk
155+
is low. See [blog][0.15.0-blog-card].
156+
153157
**Other changes**:
154158

155159
- **Internationalization**: [added and updated
156160
translations][0.15.0-blog-internationalization].
157161
- Fixed community/footer links so site-local links no longer open in a new
158162
browser target ([#2133][], [#2576][]).
159163

160-
[**Experimental**](#experimental):
161-
162-
- **[Agent support][0.15.0-blog-agent-support]**: added Markdown alternate
163-
outputs, "View Markdown" links, and `llms.txt` ([#2597][], [#2601][],
164-
[#2605][], [#2606][]).
165-
166-
For maintainers:
167-
168-
- Split deployment docs into focused pages and clarified release branch-model
169-
docs ([#2556][], [#2572][]).
170-
- Updated NPM packages and `docsy.dev` tooling, including `hugo-extended`
171-
0.157.0 ([#2585][]).
172-
- Added `siteGetPage` shortcode ([#2586][]) — **internal** to `docsy.dev`; not
173-
part of Docsy's [public customization surface](#public) and may change or be
174-
removed without notice.
175-
176164
[#2133]: https://github.com/google/docsy/issues/2133
177-
[#2556]: https://github.com/google/docsy/pull/2556
178165
[#2557]: https://github.com/google/docsy/pull/2557
179166
[#2563]: https://github.com/google/docsy/pull/2563
180167
[#2565]: https://github.com/google/docsy/pull/2565
181-
[#2572]: https://github.com/google/docsy/pull/2572
182168
[#2576]: https://github.com/google/docsy/pull/2576
183169
[#2580]: https://github.com/google/docsy/pull/2580
184-
[#2585]: https://github.com/google/docsy/pull/2585
185170
[#2586]: https://github.com/google/docsy/pull/2586
186171
[#2587]: https://github.com/google/docsy/pull/2587
187172
[#2597]: https://github.com/google/docsy/pull/2597

docsy.dev/content/en/project/about/maintainer-notes.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -80,40 +80,56 @@ truth for what the changelog and release blog must cover.
8080
## Publishing a release
8181

8282
These notes are WIP for creating a **release** from a local copy of the repo.
83-
These instructions assume the release is {{% param version %}}, if not adjust
84-
accordingly.
83+
These instructions assume the release is:
84+
85+
- **{{% dev-version final %}}**
86+
87+
If not adjust accordingly.
8588

8689
> [!IMPORTANT]
8790
>
8891
> Before creating a release, do a [release-prep audit](#release-prep-audit) and
8992
> use it to drive the changelog and release-blog updates in the next two steps.
9093
9194
1. **Change directory** to your local Docsy repo.
95+
- Expecting final adjustments as you prepare for the release? Create a
96+
branch to work from. For example:
97+
98+
```sh
99+
git checkout -b release-{{% dev-version final %}}-prep
100+
# Or you have a local create-branch alias:
101+
gcb release-{{% dev-version final %}}-prep
102+
```
103+
104+
- Serve the site and continue working through these steps from the served
105+
version of these notes.
92106

93-
2. **Create or update a [changelog][] entry** for {{% param version %}}.
107+
2. **Create or update a [changelog][] entry** for {{% dev-version final %}}.
94108
- This step is driven by the [release-prep audit](#release-prep-audit).
95109
- The section should provide a brief summary of breaking changes using the
96110
section template at the end of the file.
97111
- Ensure to remove the UNRELEASED note, if still present.
98112
- You'll create a new section for the next release in a later step.
99113
100-
3. **Update the release report blog post** for {{% param version %}}, if any.
114+
3. **Update the release report blog post** for {{% dev-version final %}}, if
115+
any.
101116
- Remove draft status.
102117
- Set `date` (or `lastmod` if already published) to today's date.
103118

104119
4. Run `npm run fix`.
105120

106-
5. **Update Docsy version** to {{% param version %}} using the following from a
107-
(bash or zsh) terminal.
121+
5. **Update Docsy version** to {{% dev-version final %}} using the following
122+
from a (bash or zsh) terminal.
108123
- First set the `VERSION` variable; we use it throughout the steps below.
109124

110125
```sh
111-
VERSION={{% param version %}}
126+
VERSION={{% dev-version final %}}
112127
```
113128

114129
- Then run the `set:version` script.
115130

116-
Docsy is probably already at `{{% param version %}}-dev`, so you can run:
131+
Docsy is probably already at `{{% dev-version final %}}-dev`, so you can
132+
run:
117133

118134
```sh
119135
npm run set:version
@@ -143,7 +159,7 @@ accordingly.
143159
- Commit any changes accumulated from the previous steps using this title:
144160

145161
```text
146-
Release {{% param version %}} preparation
162+
Release {{% param tdVersion.latest %}} preparation
147163
```
148164

149165
- Create a PR (with version-checks disabled) using the following command
@@ -177,14 +193,14 @@ accordingly.
177193

178194
12. **Ensure** that you're:
179195
- On the target `$BASE` branch
180-
- At the commit that you want to tag as {{% param version %}}
196+
- At the commit that you want to tag as {{% param tdVersion.latest %}}
181197
182-
13. **Create the new tag** for {{% param version %}}.
198+
13. **Create the new tag** for {{% param tdVersion.latest %}}.
183199
- Set the REL variable to the release version or use the `VERSION` variable
184200
if you set it in the previous step.
185201
186202
```sh
187-
REL=v${VERSION:-{{% param version %}}}
203+
REL=v${VERSION:-{{% param tdVersion.latest %}}}
188204
echo "REL=$REL"
189205
```
190206
@@ -253,10 +269,10 @@ accordingly.
253269

254270
```console
255271
$ git push-all-remotes $REL
256-
+ git push origin {{% param version %}}
257-
* [new tag] {{% param version %}} -> {{% param version %}}
258-
+ git push upstream {{% param version %}}
259-
* [new tag] {{% param version %}} -> {{% param version %}}
272+
+ git push origin {{% param tdVersion.latest %}}
273+
* [new tag] {{% param tdVersion.latest %}} -> {{% param tdVersion.latest %}}
274+
+ git push upstream {{% param tdVersion.latest %}}
275+
* [new tag] {{% param tdVersion.latest %}} -> {{% param tdVersion.latest %}}
260276
...
261277
```
262278

@@ -310,15 +326,15 @@ accordingly.
310326
been updated to the new release.
311327
312328
17. **[Draft a new release][]** using GitHub web; fill in the fields as follows:
313-
- Visit [tags][] to find the new release tag {{% param version %}}.
329+
- Visit [tags][] to find the new release tag {{% param tdVersion.latest %}}.
314330
315-
- Select Create a new release from the {{% param version %}} tag dropdown
316-
menu
331+
- Select Create a new release from the {{% param tdVersion.latest %}} tag
332+
dropdown menu
317333
318334
- **Release title**: use the release version.
319335
320336
```text
321-
{{% param version %}}
337+
{{% param tdVersion.latest %}}
322338
```
323339
324340
- Click **Generate release notes** to get the release details inserted into
@@ -395,7 +411,7 @@ before any further changes are merged into the `main` branch:
395411
3. **Submit a PR with your changes**, using a title like:
396412
397413
```text
398-
Set version to {{% param version %}}
414+
Set version to {{% param tdVersion.latest %}}
399415
```
400416
401417
4. **Get PR approved and merged**.

docsy.dev/layouts/_shortcodes/dev-version.html

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,26 @@
1+
{{/*
2+
Returns the development version of Docsy.
3+
4+
Usage: {{% dev-version [final] %}}
5+
6+
The development version is read from .Params.version in the page's front
7+
matter. If [as-final-version] is true, the final non-dev version is returned,
8+
as derived from the dev version. For example, v0.15.0-dev → v0.15.0.
9+
10+
*/ -}}
11+
12+
{{ $finalVersion := eq (.Get 0) "final" -}}
113
{{ with $.Site.Params.tdVersion.dev -}}
2-
{{ . -}}
3-
{{ with $.Site.Params.tdVersion.buildId -}}
4-
+{{ replace . "+" "-" -}}
14+
{{ $devVersion := . -}}
15+
{{ if $finalVersion -}}
16+
{{ replace $devVersion "-dev" "" -}}
17+
{{ else -}}
18+
{{ . -}}
19+
{{ with $.Site.Params.tdVersion.buildId -}}
20+
+{{ replace . "+" "-" -}}
21+
{{ end -}}
522
{{ end -}}
23+
624
{{ else -}}
725
{{ with $.Site.Params.version -}}
826
{{ replace . " " "_" -}}

layouts/_shortcodes/siteGetPage.html renamed to docsy.dev/layouts/_shortcodes/siteGetPage.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
{{- /*
22

3-
Returns a property (RelPermalink or Permalink) of the page at the given
4-
site-relative path. Internal to docsy.dev test pages; not part of Docsy's
5-
public customization surface and may change or be removed without notice.
3+
Returns a property of the page at the given site-relative path.
4+
Currently used in mock/test homepages.
65

76
Usage: {{% siteGetPage "/path/to/page" "RelPermalink" %}}
87

0 commit comments

Comments
 (0)