From e84233ae5d8e9a6b79f307d56c338458b9f2f071 Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Tue, 25 Aug 2026 12:23:09 +0200 Subject: [PATCH 1/5] docs(web): use active doc version for install manifest link The install snippet always linked to the manifest of the latest released version, regardless of which versioned docs page it was rendered on. Viewing the 0.13.0 installation page therefore pointed at the 0.14.0 manifest. Fall back to the latest released version only when there is no active version, or the active version is the unreleased "current" docs. Signed-off-by: Marco Nenciarini --- web/src/components/Installation/index.tsx | 3 +-- web/src/hooks/versions.ts | 5 ++++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index 064a0ea..9bf8fca 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -5,7 +5,7 @@ import {useCurrentVersion} from '@site/src/hooks/versions'; // InstallationSnippet is the kubectl incantation to install the lastest // available version of the Barman Cloud Plugin. export function InstallationSnippet(): ReactElement { - const latest = useCurrentVersion('latestReleased'); + const latest = useCurrentVersion('latest'); return ( {`kubectl apply -f \\ @@ -13,4 +13,3 @@ export function InstallationSnippet(): ReactElement { ); } - diff --git a/web/src/hooks/versions.ts b/web/src/hooks/versions.ts index 785cc2f..463e0f5 100644 --- a/web/src/hooks/versions.ts +++ b/web/src/hooks/versions.ts @@ -7,7 +7,10 @@ export function useCurrentVersion(fallback: 'latest' | 'latestReleased' = 'lates return useLatestReleasedVersion(); case 'latest': { const version = useActiveVersion('default'); - return version?.name ?? useLatestVersion('default')?.name; + if (version && version.name !== 'current') { + return version.name; + } + return useLatestReleasedVersion(); } default: // The following line ensures that if `fallback` is not 'latest' or 'latestReleased', From f2bde97808343b14cc606abf6b83e67fd364220d Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Tue, 25 Aug 2026 12:23:25 +0200 Subject: [PATCH 2/5] refactor(web): simplify useLatestReleasedVersion Docusaurus already exposes the latest released version via useLatestVersion (backed by GlobalVersion.isLast), making the manual filter and numeric-string sort redundant. Signed-off-by: Marco Nenciarini --- web/src/hooks/versions.ts | 19 ++----------------- 1 file changed, 2 insertions(+), 17 deletions(-) diff --git a/web/src/hooks/versions.ts b/web/src/hooks/versions.ts index 463e0f5..af79a70 100644 --- a/web/src/hooks/versions.ts +++ b/web/src/hooks/versions.ts @@ -1,4 +1,4 @@ -import {useActiveVersion, useLatestVersion, useVersions} from '@docusaurus/plugin-content-docs/client'; +import {useActiveVersion, useLatestVersion} from '@docusaurus/plugin-content-docs/client'; export function useCurrentVersion(fallback: 'latest' | 'latestReleased' = 'latest'): string { @@ -20,20 +20,5 @@ export function useCurrentVersion(fallback: 'latest' | 'latestReleased' = 'lates } export function useLatestReleasedVersion(): string { - const allVersions = useVersions('default'); - - // Filter out "current" to only consider versioned docs - const versionedDocs = allVersions.filter(version => version.name !== 'current'); - - // Handle the case where no versioned documents are found - if (versionedDocs.length === 0) { - return "unknown_version"; - } - - const sortedVersions = versionedDocs.sort((a, b) => { - return b.name.localeCompare(a.name, undefined, { numeric: true, sensitivity: 'base' }); - }); - - // The latest version is the first in the sorted list since versionedDocs was not empty, - return sortedVersions[0].name; + return useLatestVersion('default').name; } From ecdc4bdc594355cde22bccf8de30a945ff48876f Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Tue, 25 Aug 2026 12:23:36 +0200 Subject: [PATCH 3/5] feat(web): point unreleased docs install snippet at main manifest The unversioned "current" docs describe unreleased functionality, so a tagged release manifest doesn't make sense there. Install from the manifest built off main instead. Signed-off-by: Marco Nenciarini --- web/src/components/Installation/index.tsx | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index 9bf8fca..b2223c4 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -1,15 +1,21 @@ import {ReactElement} from 'react'; import CodeBlock from '@theme/CodeBlock'; +import {useActiveVersion} from '@docusaurus/plugin-content-docs/client'; import {useCurrentVersion} from '@site/src/hooks/versions'; -// InstallationSnippet is the kubectl incantation to install the lastest -// available version of the Barman Cloud Plugin. +// InstallationSnippet is the kubectl incantation to install the Barman +// Cloud Plugin: the manifest matching the doc version being viewed, or +// (on the unreleased "current" docs) the latest manifest on main. export function InstallationSnippet(): ReactElement { - const latest = useCurrentVersion('latest'); + const activeVersion = useActiveVersion('default'); + const version = useCurrentVersion('latest'); + const url = activeVersion?.name === 'current' + ? 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml' + : `https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v${version}/manifest.yaml`; return ( {`kubectl apply -f \\ - https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v${latest}/manifest.yaml`} + ${url}`} ); } From 1f0ade2d5c5bf1520a20773f28620e53d98c325f Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Tue, 25 Aug 2026 14:06:27 +0200 Subject: [PATCH 4/5] refactor(web): drop the now-dead useCurrentVersion abstraction useCurrentVersion's 'latestReleased' branch had no remaining caller after the previous commit, and InstallationSnippet was calling useActiveVersion twice (once directly, once through the hook) to re-run the same check. Build the manifest URL straight from the active version and drop hooks/versions.ts entirely. Signed-off-by: Marco Nenciarini --- web/src/components/Installation/index.tsx | 8 +++----- web/src/hooks/versions.ts | 24 ----------------------- 2 files changed, 3 insertions(+), 29 deletions(-) delete mode 100644 web/src/hooks/versions.ts diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index b2223c4..b149709 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -1,17 +1,15 @@ import {ReactElement} from 'react'; import CodeBlock from '@theme/CodeBlock'; import {useActiveVersion} from '@docusaurus/plugin-content-docs/client'; -import {useCurrentVersion} from '@site/src/hooks/versions'; // InstallationSnippet is the kubectl incantation to install the Barman // Cloud Plugin: the manifest matching the doc version being viewed, or // (on the unreleased "current" docs) the latest manifest on main. export function InstallationSnippet(): ReactElement { const activeVersion = useActiveVersion('default'); - const version = useCurrentVersion('latest'); - const url = activeVersion?.name === 'current' - ? 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml' - : `https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v${version}/manifest.yaml`; + const url = activeVersion && activeVersion.name !== 'current' + ? `https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v${activeVersion.name}/manifest.yaml` + : 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml'; return ( {`kubectl apply -f \\ diff --git a/web/src/hooks/versions.ts b/web/src/hooks/versions.ts deleted file mode 100644 index af79a70..0000000 --- a/web/src/hooks/versions.ts +++ /dev/null @@ -1,24 +0,0 @@ -import {useActiveVersion, useLatestVersion} from '@docusaurus/plugin-content-docs/client'; - - -export function useCurrentVersion(fallback: 'latest' | 'latestReleased' = 'latest'): string { - switch (fallback) { - case 'latestReleased': - return useLatestReleasedVersion(); - case 'latest': { - const version = useActiveVersion('default'); - if (version && version.name !== 'current') { - return version.name; - } - return useLatestReleasedVersion(); - } - default: - // The following line ensures that if `fallback` is not 'latest' or 'latestReleased', - // an error is thrown. This can be useful for catching unexpected states. - throw new Error(`Unhandled fallback type: ${fallback}`); - } -} - -export function useLatestReleasedVersion(): string { - return useLatestVersion('default').name; -} From f9e59c5d7a90ed2a8e8ae3e74f043c351590a2f3 Mon Sep 17 00:00:00 2001 From: Danish Date: Thu, 27 Aug 2026 14:25:22 +0530 Subject: [PATCH 5/5] docs(web): show the doc version in the install manifest text (#1077) The installation page said "the manifest for the latest release" everywhere, even on older versioned docs and on the unreleased Dev docs. Show the actual version instead (or "the latest development snapshot from the main branch" on Dev docs). The "Testing the latest development snapshot" section now explains, on Dev docs, that the command above already installs that snapshot, instead of duplicating it. Signed-off-by: Danish --- web/docs/installation.mdx | 13 ++----- web/src/components/Installation/index.tsx | 38 ++++++++++++++++++- .../version-0.13.0/installation.mdx | 13 ++----- .../version-0.14.0/installation.mdx | 13 ++----- 4 files changed, 49 insertions(+), 28 deletions(-) diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 027d1e8..4c1c48a 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -54,10 +54,9 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin -import { InstallationSnippet } from '@site/src/components/Installation'; +import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation'; -Install the plugin using `kubectl` by applying the manifest for the latest -release: +Install the plugin using `kubectl` by applying the manifest for : @@ -100,10 +99,6 @@ This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot -You can also test the latest development snapshot of the plugin with the -following command: +import { DevSnapshotSection } from '@site/src/components/Installation'; -```sh -kubectl apply -f \ - https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml -``` + diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index b149709..359bd95 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -2,6 +2,10 @@ import {ReactElement} from 'react'; import CodeBlock from '@theme/CodeBlock'; import {useActiveVersion} from '@docusaurus/plugin-content-docs/client'; +// DEV_MANIFEST_URL is the URL of the manifest.yaml on the main branch of the plugin repo. +const DEV_MANIFEST_URL = + 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml'; + // InstallationSnippet is the kubectl incantation to install the Barman // Cloud Plugin: the manifest matching the doc version being viewed, or // (on the unreleased "current" docs) the latest manifest on main. @@ -9,7 +13,7 @@ export function InstallationSnippet(): ReactElement { const activeVersion = useActiveVersion('default'); const url = activeVersion && activeVersion.name !== 'current' ? `https://github.com/cloudnative-pg/plugin-barman-cloud/releases/download/v${activeVersion.name}/manifest.yaml` - : 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml'; + : DEV_MANIFEST_URL; return ( {`kubectl apply -f \\ @@ -17,3 +21,35 @@ export function InstallationSnippet(): ReactElement { ); } + +// ManifestVersion names the manifest the snippet below installs: the +// release tag for a versioned docs page, or the main branch on Dev docs. +export function ManifestVersion(): ReactElement { + const activeVersion = useActiveVersion('default'); + return activeVersion && activeVersion.name !== 'current' + ? v{activeVersion.name} + : <>the latest development snapshot from the main branch; +} + +// DevSnapshotSection offers the main-branch manifest as an alternative; +// on the Dev docs the main install already is that manifest, so hide it. +export function DevSnapshotSection(): ReactElement { + const activeVersion = useActiveVersion('default'); + if (!activeVersion || activeVersion.name === 'current') { + return ( +

The install + command above already applies the latest development + snapshot from the main branch.

+ ); + } + return ( + <> +

You can also test the latest development snapshot of the plugin + with the following command:

+ + {`kubectl apply -f \\ + ${DEV_MANIFEST_URL}`} + + + ); +} diff --git a/web/versioned_docs/version-0.13.0/installation.mdx b/web/versioned_docs/version-0.13.0/installation.mdx index 027d1e8..4c1c48a 100644 --- a/web/versioned_docs/version-0.13.0/installation.mdx +++ b/web/versioned_docs/version-0.13.0/installation.mdx @@ -54,10 +54,9 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin -import { InstallationSnippet } from '@site/src/components/Installation'; +import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation'; -Install the plugin using `kubectl` by applying the manifest for the latest -release: +Install the plugin using `kubectl` by applying the manifest for : @@ -100,10 +99,6 @@ This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot -You can also test the latest development snapshot of the plugin with the -following command: +import { DevSnapshotSection } from '@site/src/components/Installation'; -```sh -kubectl apply -f \ - https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml -``` + diff --git a/web/versioned_docs/version-0.14.0/installation.mdx b/web/versioned_docs/version-0.14.0/installation.mdx index 027d1e8..4c1c48a 100644 --- a/web/versioned_docs/version-0.14.0/installation.mdx +++ b/web/versioned_docs/version-0.14.0/installation.mdx @@ -54,10 +54,9 @@ Both checks are required before proceeding with the installation. ## Installing the Barman Cloud Plugin -import { InstallationSnippet } from '@site/src/components/Installation'; +import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation'; -Install the plugin using `kubectl` by applying the manifest for the latest -release: +Install the plugin using `kubectl` by applying the manifest for : @@ -100,10 +99,6 @@ This confirms that the plugin is deployed and ready to use. ## Testing the latest development snapshot -You can also test the latest development snapshot of the plugin with the -following command: +import { DevSnapshotSection } from '@site/src/components/Installation'; -```sh -kubectl apply -f \ - https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml -``` +