diff --git a/web/docs/installation.mdx b/web/docs/installation.mdx index 01ee3c7..4c1c48a 100644 --- a/web/docs/installation.mdx +++ b/web/docs/installation.mdx @@ -97,6 +97,8 @@ deployment "barman-cloud" successfully rolled out This confirms that the plugin is deployed and ready to use. +## Testing the latest development snapshot + import { DevSnapshotSection } from '@site/src/components/Installation'; diff --git a/web/src/components/Installation/index.tsx b/web/src/components/Installation/index.tsx index 255abdd..359bd95 100644 --- a/web/src/components/Installation/index.tsx +++ b/web/src/components/Installation/index.tsx @@ -1,7 +1,10 @@ import {ReactElement} from 'react'; import CodeBlock from '@theme/CodeBlock'; import {useActiveVersion} from '@docusaurus/plugin-content-docs/client'; -import Heading from '@theme/Heading'; + +// 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 @@ -10,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 \\ @@ -24,25 +27,28 @@ export function InstallationSnippet(): ReactElement { export function ManifestVersion(): ReactElement { const activeVersion = useActiveVersion('default'); return activeVersion && activeVersion.name !== 'current' - ? <>version v{activeVersion.name} + ? 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 | null { +export function DevSnapshotSection(): ReactElement { const activeVersion = useActiveVersion('default'); - const url = 'https://raw.githubusercontent.com/cloudnative-pg/plugin-barman-cloud/refs/heads/main/manifest.yaml'; - if (!activeVersion || activeVersion.name === 'current') return null; + if (!activeVersion || activeVersion.name === 'current') { + return ( +

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

+ ); + } return ( <> - - Testing the latest development snapshot - +

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

{`kubectl apply -f \\ - ${url}`} + ${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 01ee3c7..4c1c48a 100644 --- a/web/versioned_docs/version-0.13.0/installation.mdx +++ b/web/versioned_docs/version-0.13.0/installation.mdx @@ -97,6 +97,8 @@ deployment "barman-cloud" successfully rolled out This confirms that the plugin is deployed and ready to use. +## Testing the latest development snapshot + import { DevSnapshotSection } from '@site/src/components/Installation'; diff --git a/web/versioned_docs/version-0.14.0/installation.mdx b/web/versioned_docs/version-0.14.0/installation.mdx index 01ee3c7..4c1c48a 100644 --- a/web/versioned_docs/version-0.14.0/installation.mdx +++ b/web/versioned_docs/version-0.14.0/installation.mdx @@ -97,6 +97,8 @@ deployment "barman-cloud" successfully rolled out This confirms that the plugin is deployed and ready to use. +## Testing the latest development snapshot + import { DevSnapshotSection } from '@site/src/components/Installation';