diff --git a/assets/scss/td/_nav.scss b/assets/scss/td/_nav.scss index a7d0991c9..6a990ac68 100644 --- a/assets/scss/td/_nav.scss +++ b/assets/scss/td/_nav.scss @@ -162,6 +162,12 @@ $td-link-underline-offsets: ( content: ' (latest)'; } } + + &-next { + &::after { + content: ' (next)'; + } + } } } diff --git a/docsy.dev/config/_default/params.yaml b/docsy.dev/config/_default/params.yaml index 1740df017..9aa830b33 100644 --- a/docsy.dev/config/_default/params.yaml +++ b/docsy.dev/config/_default/params.yaml @@ -6,31 +6,26 @@ # version: # status: archived # Then fetch include -version: &docsyVersion 0.14.4-dev -tdBuildId: 022-over-main-6884d94e -versionLatest: &versionLatest v0.14.3 -version_menu: *docsyVersion +tdVersion: + latest: &tdLatestVers v0.14.3 + dev: &tdDevVers v0.14.4-dev + buildId: &tdBuildId 023-over-main-3bcb7385 + +version: *tdDevVers +version_menu: *tdDevVers version_menu_pagelinks: true versions: - # - name: '**About**' - # url: /project - # pagelinks: false - # - name: --- - name: '**Versions**' - - name: Next - version: *docsyVersion - # TODO: use https://next.docsy.dev once it's available - url: https://main--docsydocs.netlify.app - - version: *versionLatest - url: https://www.docsy.dev + - version: *tdDevVers + # kind: next + pagelinks: true + url: https://main--docsydocs.netlify.app # TODO: use next.docsy.dev once available + - version: *tdLatestVers kind: latest + url: https://www.docsy.dev - name: --- - name: '**Variant**' - - name: Doc-rooted - url: https://doc-rooted--docsydocs.netlify.app - # TODO: implement /docs/* redirects for doc-rooted site, then drop pagelinks:false - pagelinks: false + - name: Doc-rooted (experimental) kind: home - # - name: Goldydocs - # url: https://example.docsy.dev - # pagelinks: false + pagelinks: false # TODO: drop this once /docs/* redirects are implemented + url: https://doc-rooted--docsydocs.netlify.app diff --git a/docsy.dev/config/doc-rooted/params.yaml b/docsy.dev/config/doc-rooted/params.yaml index 67e79a171..a3b37be96 100644 --- a/docsy.dev/config/doc-rooted/params.yaml +++ b/docsy.dev/config/doc-rooted/params.yaml @@ -1,13 +1,26 @@ # cSpell:ignore pagelinks -version: &docsyVersion 0.14.3 -version_menu: *docsyVersion +tdVersion: + latest: &tdLatestVers v0.14.3 + dev: &tdDevVers v0.14.4-dev + buildId: &tdBuildId 023-over-main-3bcb7385 + +version: &tdDocRootedVers Doc-rooted of Next +version_menu: *tdLatestVers +version_menu_pagelinks: false versions: + - name: '**Versions**' - name: Next - kind: next - url: https://main--docsydocs.netlify.app/ - pagelinks: false - - version: *docsyVersion + version: *tdDevVers + # kind: next + url: https://main--docsydocs.netlify.app + - version: *tdLatestVers kind: latest url: https://www.docsy.dev - pagelinks: false + - name: --- + - name: '**Variant**' + - name: Doc-rooted (experimental) + version: *tdDocRootedVers + kind: home + pagelinks: false # TODO: drop this once /docs/* redirects are implemented + url: https://doc-rooted--docsydocs.netlify.app diff --git a/docsy.dev/config/production/params.yaml b/docsy.dev/config/production/params.yaml index d3742d70a..dd5d15c6b 100644 --- a/docsy.dev/config/production/params.yaml +++ b/docsy.dev/config/production/params.yaml @@ -1,13 +1,18 @@ # cSpell:ignore pagelinks -version: &docsyVersion 0.14.3 -version_menu: *docsyVersion +tdVersion: + latest: &tdLatestVers v0.14.3 + dev: &tdDevVers v0.14.4-dev + buildId: &tdBuildId 023-over-main-3bcb7385 + +version: *tdLatestVers +version_menu: *tdLatestVers versions: + - name: '**Versions**' - name: Next - kind: next - url: https://main--docsydocs.netlify.app/ - pagelinks: true - - version: *docsyVersion + version: *tdDevVers + # kind: next + url: https://main--docsydocs.netlify.app + - version: *tdLatestVers kind: latest url: https://www.docsy.dev - pagelinks: true diff --git a/docsy.dev/content/en/docs/get-started/other-options.md b/docsy.dev/content/en/docs/get-started/other-options.md index 489147a04..4975d8d9d 100644 --- a/docsy.dev/content/en/docs/get-started/other-options.md +++ b/docsy.dev/content/en/docs/get-started/other-options.md @@ -165,7 +165,7 @@ your project's root directory: ```sh git submodule add https://github.com/google/docsy.git themes/docsy cd themes/docsy - git checkout v{{% param version %}} + git checkout {{% param version %}} ``` To work from the development version of Docsy (_not recommended_), run the @@ -229,12 +229,12 @@ maintain your own copy of the theme directly, or your deployment choice requires you to include a copy of the theme in your repository), you can clone the theme into your project's `themes` subdirectory. -To clone Docsy at v{{% param version %}} into your project's `themes` folder, -run the following commands from your project's root directory: +To clone Docsy at {{% param version %}} into your project's `themes` folder, run +the following commands from your project's root directory: ```sh cd themes -git clone -b v{{% param version %}} https://github.com/google/docsy +git clone -b {{% param version %}} https://github.com/google/docsy cd docsy npm install ``` @@ -243,7 +243,7 @@ npm install To work from the development version of Docsy (not recommended unless, for example, you plan to upstream changes to Docsy), omit the -`-b v{{% param version %}}` argument from the clone command above. +`-b {{% param version %}}` argument from the clone command above. Then consider setting up an NPM [prepare][] script, as documented in Option 1. diff --git a/docsy.dev/content/en/project/about/maintainer-notes.md b/docsy.dev/content/en/project/about/maintainer-notes.md index f2d3d545c..f617de8ba 100644 --- a/docsy.dev/content/en/project/about/maintainer-notes.md +++ b/docsy.dev/content/en/project/about/maintainer-notes.md @@ -28,12 +28,6 @@ accordingly. 4. Run `npm run fix`. - > [!NOTE] - > - > This command might update the version in `package.json` via `fix:version`, - > but you can ignore this change since you'll be setting the version - > explicitly in the next step. - 5. **Update Docsy version** to {{% param version %}} using the following from a (bash or zsh) terminal. - First set the `VERSION` variable; we use it throughout the steps below. @@ -184,10 +178,10 @@ accordingly. ```console $ git push-all-remotes $REL - + git push origin v{{% param version %}} - * [new tag] v{{% param version %}} -> v{{% param version %}} - + git push upstream v{{% param version %}} - * [new tag] v{{% param version %}} -> v{{% param version %}} + + git push origin {{% param version %}} + * [new tag] {{% param version %}} -> {{% param version %}} + + git push upstream {{% param version %}} + * [new tag] {{% param version %}} -> {{% param version %}} ... ``` @@ -241,15 +235,15 @@ accordingly. been updated to the new release. 17. **[Draft a new release][]** using GitHub web; fill in the fields as follows: - - Visit [tags][] to find the new release tag v{{% param version %}}. + - Visit [tags][] to find the new release tag {{% param version %}}. - - Select Create a new release from the v{{% param version %}} tag dropdown + - Select Create a new release from the {{% param version %}} tag dropdown menu - **Release title**: use the release version. ```text - v{{% param version %}} + {{% param version %}} ``` - Click **Generate release notes** to get the release details inserted into @@ -299,7 +293,7 @@ with the following modifications: ## Post Docsy-release followup -Assuming that both the Docsy and Docsy-example releases v{{% param version %}} +Assuming that both the Docsy and Docsy-example releases {{% param version %}} have been successfully deployed, and that at least one other project has been successfully tested with the new release, then perform the following actions before any further changes are merged into the `main` branch: @@ -307,12 +301,12 @@ before any further changes are merged into the `main` branch: 1. Update the package version to a dev ID for Docsy and Docsy-example: ```console - $ npm run -s fix:version + $ npm run -s set:version:git-info ✓ Updated package.json version: 0.14.3 → 0.14.3-dev+003-over-main-cf4f514b ✓ Updated docsy.dev/config/_default/params.yaml version: 0.14.3 → 0.14.3-dev ✓ Updated docsy.dev/config/_default/params.yaml tdBuildId: (none) → 003-over-main-cf4f514b ... - $ npm run -s fix:version:example + $ npm run -s set:version:example:git-info ... ``` @@ -333,7 +327,7 @@ before any further changes are merged into the `main` branch: ## Release helper scripts -- NPM scripts: `fix:version`, `fix:version:example`, and `set:version`. +- NPM scripts: `set:version` and `set:version:*` - `scripts/get-build-id.sh`: Generates build ID from git describe (empty on tags). - `scripts/set-package-version/index.mjs`: Low-level version manager. See script diff --git a/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md b/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md index 208306f58..f71cbeae0 100644 --- a/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md +++ b/docsy.dev/content/en/tests/blocks-cover/color-gradient/index.md @@ -17,7 +17,8 @@ description: A Hugo theme for creating great technical documentation sites