From 8138e51ad5506e91da107f148ae730577fe1fb8d Mon Sep 17 00:00:00 2001 From: Marco Nenciarini Date: Thu, 3 Sep 2026 16:39:24 +0200 Subject: [PATCH] fix: clarify what the dev docs install On the dev docs, the Helm tab installs the latest release, but the kubectl tab installs the main branch. Nothing on the page said this, and Helm was the tab shown by default. Add a note, and make both tabs link to each other, so a reader can jump straight to the right one. Signed-off-by: Marco Nenciarini --- web/docs/installation.mdx | 6 ++++-- web/src/components/Installation/index.tsx | 13 +++++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 9df96d1..bff100b 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -59,10 +59,12 @@ import TabItem from '@theme/TabItem'; import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; - + -The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud): +The plugin can be installed using the provided [Helm chart](https://github.com/cloudnative-pg/charts/tree/main/charts/plugin-barman-cloud). +This installs the latest published chart release; to test an unreleased +development snapshot instead, switch to the [**Manifest (kubectl)**](./?install-method=kubectl#installing-the-barman-cloud-plugin) tab. diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index 359bd95..787c73f 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -1,5 +1,7 @@ import {ReactElement} from 'react'; import CodeBlock from '@theme/CodeBlock'; +import Link from '@docusaurus/Link'; +import {useLocation} from '@docusaurus/router'; 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. @@ -31,14 +33,17 @@ export function ManifestVersion(): ReactElement { : <>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. +// DevSnapshotSection shows how to test the main-branch manifest. On +// the Dev docs, the kubectl install above already does that, so we +// hide this section there. (The Helm tab there installs the latest +// release, not a dev build.) export function DevSnapshotSection(): ReactElement { const activeVersion = useActiveVersion('default'); + const {pathname} = useLocation(); if (!activeVersion || activeVersion.name === 'current') { return ( -

The install - command above already applies the latest development +

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

); }