Skip to content

Commit 712aa05

Browse files
authored
Release 0.10.0 prep (#1983)
1 parent b0e7f0d commit 712aa05

File tree

8 files changed

+25
-20
lines changed

8 files changed

+25
-20
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ dark-mode support][dark-mode].
4848
styling: `$border-color`, `$td-sidebar-tree-root-color`,
4949
`$td-sidebar-bg-color`, `$td-sidebar-border-color` ([#1952])
5050

51+
**Style changes** (potentially breaking):
52+
53+
- The style of various shortcode and elements have been adjusted so that they
54+
are compatible with light/dark mode. For details see, **Important style
55+
changes** in [Color themes and dark-mode support][dark-mode].
56+
5157
[#1952]: https://github.com/google/docsy/pull/1952
5258
[0.10.0]: https://github.com/google/docsy/releases/latest?FIXME=v0.10.0
5359
[0.10.0 release report]: https://www.docsy.dev/blog/?FIXME=2024/0.10.0/

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ repo.
5353
3. **Update Docsy version** to v0.X.Y for:
5454
- `version` key in [package.json](package.json)
5555
- `version` key in [userguide/hugo.yaml][]
56-
4. Run `npm install` to have vendor assets and [go.mod](go.mod) updated for
57-
dependencies.
56+
4. Run `npm run ci:prrepare` to ensure that vendor assets and [go.mod](go.mod)
57+
dependencies are up-to-date.
5858
5. **Submit a PR with your changes**, using a title like "Release v0.X.Y
5959
preparation".
6060
6. **Test the PR** branch from selected sites, and push any required

netlify.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
[build]
55
publish = "userguide/public"
6-
command = "npm run ci:prepare && npm run build:preview"
6+
command = "npm run docs-install && npm run build:preview"
77

88
[build.environment]
99
GO_VERSION = "1.21.6"
1010
HUGO_THEME = "repo"
1111

1212
[context.production]
13-
command = "npm run ci:prepare && npm run build:production"
13+
command = "npm run docs-install && npm run build:production"

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "docsy",
3-
"version": "0.10.0-dev.0-unreleased",
3+
"version": "0.10.0",
44
"version.next": "0.10.1-dev.0-unreleased",
55
"repository": "github:google/docsy",
66
"homepage": "https://www.docsy.dev",
@@ -12,7 +12,7 @@
1212
"_diff:check": "git diff --name-only --exit-code",
1313
"_gen-chroma-styles": "bash -c tools/gen-chroma-styles.sh && bash -c 'tools/gen-chroma-styles.sh -s onedark -o _dark.scss'",
1414
"_mkdir:hugo-mod": "npx mkdirp ../github.com/FortAwesome/Font-Awesome ../github.com/twbs/bootstrap",
15-
"_prepare": "npm run _cp:bs-rfs && npm run _gen-chroma-styles",
15+
"_prepare": "npm run _cp:bs-rfs && npm run _gen-chroma-styles && npm run get:hugo-modules",
1616
"build:preview": "npm run cd:docs build:preview",
1717
"build:production": "npm run cd:docs build:production",
1818
"build": "npm run cd:docs build",

tools/getHugoModules/index.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ function getHugoModule(npmPkgNm, hugoModuleRefAtV) {
2121
throw new Error(msg);
2222
}
2323

24-
const command = `hugo mod get ${hugoModuleRefAtV}${pkgVers}`;
24+
const command = `npx hugo mod get ${hugoModuleRefAtV}${pkgVers}`;
2525
console.log(`> ${command}`);
2626
const output = execSync(command);
2727
console.log(output.toString());

userguide/content/en/blog/2024/0.10.0.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ author: >
55
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
66
for the [Docsy Steering
77
Committee](/blog/2022/hello/#introducing-the-psc)
8-
date: 2024-04-30
9-
draft: true
8+
date: 2024-05-01
109
# prettier-ignore
11-
cSpell:ignore: CNCF Chalin subdir
10+
cSpell:ignore: CNCF Chalin subdir deprecat upvoted pageinfo lookandfeel lightdark
1211
---
1312

1413
The big news with Docsy [0.10.0] is color themes and dark mode!
@@ -40,7 +39,7 @@ the title.
4039

4140
## Color themes and dark-mode support
4241

43-
The main feature of this release is the [Upgrade to Bootstrap 5.3 #1528][#1528]
42+
The main feature of this release is the [Upgrade to Bootstrap 5.3 (#1528)][#1528]
4443
from 5.2. This minor Bootstrap release introduces support [color modes], also
4544
called color themes.
4645

@@ -90,13 +89,13 @@ had their styles adjusted as well.
9089

9190
For the complete list of changes in this release, see the [0.10.0] release entry
9291
and issue
93-
[Release 0.10.0 preparation #1759](https://github.com/google/docsy/issues/1759).
92+
[Release 0.10.0 preparation (#1759)](https://github.com/google/docsy/issues/1759).
9493

9594
## What's next?
9695

9796
Which Docsy improvements are on the horizon? For work items _tentatively_ planed
9897
for the next release, see
99-
[Release 0.11.0 preparation #1944](https://github.com/google/docsy/issues/1944).
98+
[Release 0.11.0 preparation (#1944)](https://github.com/google/docsy/issues/1944).
10099

101100
{{% alert title="Vote" color="primary" %}}
102101

userguide/content/en/blog/2024/0.9.0.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ subpart of center ([#1817]). Each part has its own class, such as
4141
This release has resolves **_the_ longest standing and first ever issue
4242
created** in Docsy!
4343

44-
- [The footer should allow a more flexible copyright statement #2][#2] by
44+
- [The footer should allow a more flexible copyright statement (#2)][#2] by
4545
[@sarahmaddox]
4646

4747
The footer copyright now supports a date-range and the site-copyright as a
@@ -89,7 +89,7 @@ Half-jokingly, Lisa commented: _All we needed was several years and a few Hugo
8989
improvements_. That is, it wasn't until [Hugo 0.112.0], released in May 2023,
9090
that the necessary [functions] became available. For details, see:
9191

92-
- [Fix links for single language sites #1744][#1744]
92+
- [Fix links for single language sites (#1744)][#1744]
9393
- [Hugo v0.112.0 - New template functions][tmpl-func], by [@jmooring]
9494

9595
We're convinced that Lisa's fix has squashed repo-link bugs for good!
@@ -99,7 +99,7 @@ sites that use mounts and that have pages configured with
9999
[path_base_for_github_subdir].
100100

101101
As can be seen from [Repository / page-meta link fixes and improvements
102-
#1841][#1841], several issues remain, but resolving [#1744] establishes the
102+
(#1841)][#1841], several issues remain, but resolving [#1744] establishes the
103103
necessary foundation for future work. The issues listed in [#1841] will be
104104
addressed in a future release through further layout refactoring and extension.
105105

@@ -148,18 +148,18 @@ the `"ui_read_more"` [language parameter] for your site's languages ([#1820]).
148148

149149
For the complete list of changes in this release, see the [0.9.0] release entry
150150
and issue
151-
[Release 0.9.0 preparation #1759](https://github.com/google/docsy/issues/1759).
151+
[Release 0.9.0 preparation (#1759)](https://github.com/google/docsy/issues/1759).
152152

153153
Which Docsy improvements are on the horizon? For work items _tentatively_ planed
154154
for the next release, see
155-
[Release 0.10.0 preparation #1812](https://github.com/google/docsy/issues/1812).
155+
[Release 0.10.0 preparation (#1812)](https://github.com/google/docsy/issues/1812).
156156

157157
Feature and fix candidates for 0.10.0 and beyond currently include more
158158
Bootstrap work, in preparation for the reintroduction of RTL support —
159159
specifically:
160160

161161
- [BSv5.2 upgrade followup](https://github.com/google/docsy/issues/1510)
162-
- [Upgrade to Bootstrap 5.3 #1528](https://github.com/google/docsy/issues/1528)
162+
- [Upgrade to Bootstrap 5.3 (#1528)](https://github.com/google/docsy/issues/1528)
163163
- [[BSv5] Reintroduce RTL support using RTLCSS bootstrap](https://github.com/google/docsy/issues/1442)
164164
- [Support adding theme colors](https://github.com/google/docsy/issues/1845)
165165

userguide/hugo.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ params:
5858
privacy_policy: https://policies.google.com/privacy
5959
version_menu: Releases
6060
archived_version: false
61-
version: 0.9.1
61+
version: 0.10.0
6262
url_latest_version: https://example.com
6363
github_repo: https://github.com/google/docsy
6464
github_project_repo: https://github.com/google/docsy

0 commit comments

Comments
 (0)