marco/plugin-barman-cloud
1
0
Fork 0
mirror of https://github.com/cloudnative-pg/plugin-barman-cloud.git synced 2026-09-04 22:22:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix: clarify what the dev docs install

Browse Source 
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 <marco.nenciarini@enterprisedb.com>
This commit is contained in:
Marco Nenciarini 2026-09-03 16:39:24 +02:00 committed by Leonardo Cecchi
parent 4961bec18d
commit 8138e51ad5
2 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
web/docs/installation.mdx
View File

@ -59,10 +59,12 @@ import TabItem from '@theme/TabItem';
import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation'; import { InstallationSnippet, ManifestVersion } from '@site/src/components/Installation';
import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation'; import { HelmInstallationSnippet } from '@site/src/components/HelmInstallation';
<Tabs groupId="install-method"> <Tabs groupId="install-method" queryString>
<TabItem value="helm" label="Helm Chart" default> <TabItem value="helm" label="Helm Chart" default>
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.
<HelmInstallationSnippet /> <HelmInstallationSnippet />

13
web/src/components/Installation/index.tsx
View File

@ -1,5 +1,7 @@
import {ReactElement} from 'react'; import {ReactElement} from 'react';
import CodeBlock from '@theme/CodeBlock'; import CodeBlock from '@theme/CodeBlock';
import Link from '@docusaurus/Link';
import {useLocation} from '@docusaurus/router';
import {useActiveVersion} from '@docusaurus/plugin-content-docs/client'; 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. // 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<null> {
: <>the latest development snapshot from the <code>main</code> branch</>; : <>the latest development snapshot from the <code>main</code> branch</>;
} }
// DevSnapshotSection offers the main-branch manifest as an alternative; // DevSnapshotSection shows how to test the main-branch manifest. On
// on the Dev docs the main install already is that manifest, so hide it. // 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 { export function DevSnapshotSection(): ReactElement {
const activeVersion = useActiveVersion('default'); const activeVersion = useActiveVersion('default');
const {pathname} = useLocation();
if (!activeVersion || activeVersion.name === 'current') { if (!activeVersion || activeVersion.name === 'current') {
return ( return (
<p>The <a href="#installing-the-barman-cloud-plugin">install <p>The <Link to={`${pathname}?install-method=kubectl#installing-the-barman-cloud-plugin`}>kubectl
command above</a> already applies the latest development install command above</Link> already applies the latest development
snapshot from the <code>main</code> branch.</p> snapshot from the <code>main</code> branch.</p>
); );
} }