Skip to content

Commit

Permalink
Release 0.10.0 prep (google#1983)
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin authored May 1, 2024
1 parent b0e7f0d commit 712aa05
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 20 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ dark-mode support][dark-mode].
styling: `$border-color`, `$td-sidebar-tree-root-color`,
`$td-sidebar-bg-color`, `$td-sidebar-border-color` ([#1952])

**Style changes** (potentially breaking):

- The style of various shortcode and elements have been adjusted so that they
are compatible with light/dark mode. For details see, **Important style
changes** in [Color themes and dark-mode support][dark-mode].

[#1952]: https://github.com/google/docsy/pull/1952
[0.10.0]: https://github.com/google/docsy/releases/latest?FIXME=v0.10.0
[0.10.0 release report]: https://www.docsy.dev/blog/?FIXME=2024/0.10.0/
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ repo.
3. **Update Docsy version** to v0.X.Y for:
- `version` key in [package.json](package.json)
- `version` key in [userguide/hugo.yaml][]
4. Run `npm install` to have vendor assets and [go.mod](go.mod) updated for
dependencies.
4. Run `npm run ci:prrepare` to ensure that vendor assets and [go.mod](go.mod)
dependencies are up-to-date.
5. **Submit a PR with your changes**, using a title like "Release v0.X.Y
preparation".
6. **Test the PR** branch from selected sites, and push any required
Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

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

[build.environment]
GO_VERSION = "1.21.6"
HUGO_THEME = "repo"

[context.production]
command = "npm run ci:prepare && npm run build:production"
command = "npm run docs-install && npm run build:production"
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "docsy",
"version": "0.10.0-dev.0-unreleased",
"version": "0.10.0",
"version.next": "0.10.1-dev.0-unreleased",
"repository": "github:google/docsy",
"homepage": "https://www.docsy.dev",
Expand All @@ -12,7 +12,7 @@
"_diff:check": "git diff --name-only --exit-code",
"_gen-chroma-styles": "bash -c tools/gen-chroma-styles.sh && bash -c 'tools/gen-chroma-styles.sh -s onedark -o _dark.scss'",
"_mkdir:hugo-mod": "npx mkdirp ../github.com/FortAwesome/Font-Awesome ../github.com/twbs/bootstrap",
"_prepare": "npm run _cp:bs-rfs && npm run _gen-chroma-styles",
"_prepare": "npm run _cp:bs-rfs && npm run _gen-chroma-styles && npm run get:hugo-modules",
"build:preview": "npm run cd:docs build:preview",
"build:production": "npm run cd:docs build:production",
"build": "npm run cd:docs build",
Expand Down
2 changes: 1 addition & 1 deletion tools/getHugoModules/index.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ function getHugoModule(npmPkgNm, hugoModuleRefAtV) {
throw new Error(msg);
}

const command = `hugo mod get ${hugoModuleRefAtV}${pkgVers}`;
const command = `npx hugo mod get ${hugoModuleRefAtV}${pkgVers}`;
console.log(`> ${command}`);
const output = execSync(command);
console.log(output.toString());
Expand Down
11 changes: 5 additions & 6 deletions userguide/content/en/blog/2024/0.10.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ author: >
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
for the [Docsy Steering
Committee](/blog/2022/hello/#introducing-the-psc)
date: 2024-04-30
draft: true
date: 2024-05-01
# prettier-ignore
cSpell:ignore: CNCF Chalin subdir
cSpell:ignore: CNCF Chalin subdir deprecat upvoted pageinfo lookandfeel lightdark
---

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

## Color themes and dark-mode support

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

Expand Down Expand Up @@ -90,13 +89,13 @@ had their styles adjusted as well.

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

## What's next?

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

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

Expand Down
12 changes: 6 additions & 6 deletions userguide/content/en/blog/2024/0.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ subpart of center ([#1817]). Each part has its own class, such as
This release has resolves **_the_ longest standing and first ever issue
created** in Docsy!

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

The footer copyright now supports a date-range and the site-copyright as a
Expand Down Expand Up @@ -89,7 +89,7 @@ Half-jokingly, Lisa commented: _All we needed was several years and a few Hugo
improvements_. That is, it wasn't until [Hugo 0.112.0], released in May 2023,
that the necessary [functions] became available. For details, see:
- [Fix links for single language sites #1744][#1744]
- [Fix links for single language sites (#1744)][#1744]
- [Hugo v0.112.0 - New template functions][tmpl-func], by [@jmooring]
We're convinced that Lisa's fix has squashed repo-link bugs for good!
Expand All @@ -99,7 +99,7 @@ sites that use mounts and that have pages configured with
[path_base_for_github_subdir].
As can be seen from [Repository / page-meta link fixes and improvements
#1841][#1841], several issues remain, but resolving [#1744] establishes the
(#1841)][#1841], several issues remain, but resolving [#1744] establishes the
necessary foundation for future work. The issues listed in [#1841] will be
addressed in a future release through further layout refactoring and extension.
Expand Down Expand Up @@ -148,18 +148,18 @@ the `"ui_read_more"` [language parameter] for your site's languages ([#1820]).
For the complete list of changes in this release, see the [0.9.0] release entry
and issue
[Release 0.9.0 preparation #1759](https://github.com/google/docsy/issues/1759).
[Release 0.9.0 preparation (#1759)](https://github.com/google/docsy/issues/1759).
Which Docsy improvements are on the horizon? For work items _tentatively_ planed
for the next release, see
[Release 0.10.0 preparation #1812](https://github.com/google/docsy/issues/1812).
[Release 0.10.0 preparation (#1812)](https://github.com/google/docsy/issues/1812).
Feature and fix candidates for 0.10.0 and beyond currently include more
Bootstrap work, in preparation for the reintroduction of RTL support —
specifically:
- [BSv5.2 upgrade followup](https://github.com/google/docsy/issues/1510)
- [Upgrade to Bootstrap 5.3 #1528](https://github.com/google/docsy/issues/1528)
- [Upgrade to Bootstrap 5.3 (#1528)](https://github.com/google/docsy/issues/1528)
- [[BSv5] Reintroduce RTL support using RTLCSS bootstrap](https://github.com/google/docsy/issues/1442)
- [Support adding theme colors](https://github.com/google/docsy/issues/1845)
Expand Down
2 changes: 1 addition & 1 deletion userguide/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ params:
privacy_policy: https://policies.google.com/privacy
version_menu: Releases
archived_version: false
version: 0.9.1
version: 0.10.0
url_latest_version: https://example.com
github_repo: https://github.com/google/docsy
github_project_repo: https://github.com/google/docsy
Expand Down

0 comments on commit 712aa05

Please sign in to comment.