diff --git a/package-lock.json b/package-lock.json index 23be135..c3d5382 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,6 +9,7 @@ "version": "0.0.0", "dependencies": { "@docusaurus/core": "3.6.3", + "@docusaurus/plugin-content-docs": "^3.6.3", "@docusaurus/preset-classic": "3.6.3", "@fortawesome/fontawesome-svg-core": "^6.7.1", "@fortawesome/free-brands-svg-icons": "^6.7.1", diff --git a/package.json b/package.json index 91420f2..60e5dbf 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,7 @@ }, "dependencies": { "@docusaurus/core": "3.6.3", + "@docusaurus/plugin-content-docs": "^3.6.3", "@docusaurus/preset-classic": "3.6.3", "@fortawesome/fontawesome-svg-core": "^6.7.1", "@fortawesome/free-brands-svg-icons": "^6.7.1", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6bdec5f..722ef91 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -11,6 +11,9 @@ importers: '@docusaurus/core': specifier: 3.6.3 version: 3.6.3(@mdx-js/react@3.1.0(@types/react@18.3.12)(react@18.3.1))(acorn@8.14.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(typescript@5.7.2) + '@docusaurus/plugin-content-docs': + specifier: ^3.6.3 + version: 3.6.3(@mdx-js/react@3.1.0(@types/react@18.3.12)(react@18.3.1))(acorn@8.14.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(typescript@5.7.2) '@docusaurus/preset-classic': specifier: 3.6.3 version: 3.6.3(@algolia/client-search@5.15.0)(@mdx-js/react@3.1.0(@types/react@18.3.12)(react@18.3.1))(@types/react@18.3.12)(acorn@8.14.0)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.17.3)(typescript@5.7.2) diff --git a/src/pages/markdown-page.md b/src/pages/markdown-page.md deleted file mode 100644 index 9756c5b..0000000 --- a/src/pages/markdown-page.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Markdown page example ---- - -# Markdown page example - -You don't need React to write simple standalone pages. diff --git a/src/pages/versions.tsx b/src/pages/versions.tsx new file mode 100644 index 0000000..e19a239 --- /dev/null +++ b/src/pages/versions.tsx @@ -0,0 +1,126 @@ +import React, { ReactNode } from 'react'; +import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; +import Link from '@docusaurus/Link'; +import { + useVersions, + useLatestVersion, +} from '@docusaurus/plugin-content-docs/client'; +import Layout from '@theme/Layout'; +import Heading from '@theme/Heading'; + +const docsPluginId = undefined; + +const VersionsArchived = { + "0.25": "/usage/quickstart", + "0.24": "/0.24.x/usage/quickstart", +}; + +const VersionsArchivedList = Object.entries(VersionsArchived); + +function DocumentationLabel() { + return ( + Documentation + ); +} + +function ReleaseNotesLabel() { + return ( + + Release Notes + + ); +} + +export default function Version(): ReactNode { + const { + siteConfig: { organizationName, projectName }, + } = useDocusaurusContext(); + const versions = useVersions(docsPluginId); + const latestVersion = useLatestVersion(docsPluginId); + const currentVersion = versions.find( + (version) => version.name === 'current', + )!; + const pastVersions = versions.filter( + (version) => version !== latestVersion && version.name !== 'current', + ); + const repoUrl = `https://github.com/go-vela/community`; + + return ( + +
+

+ + Vela versions + +

+ +
+ + + Current version + + +

+ + Here you can find the documentation for the latest release. + +

+ + + + + + + + +
{latestVersion.label} + + + + + + + +
+
+ + {(pastVersions.length > 0 || VersionsArchivedList.length > 0) && ( +
+ + + Previous versions (Not maintained anymore) + + +

+ + Here you can find documentation for past releases. + +

+ + + {VersionsArchivedList.map(([versionName, versionUrl]) => ( + latestVersion.label !== versionName ? + + + + + : <> + ))} + +
{versionName} + + + + + + + +
+
+ )} +
+ + ); +} \ No newline at end of file diff --git a/versioned_docs/version-1.0/installation/_category_.json b/versioned_docs/version-0.24/installation/_category_.json similarity index 100% rename from versioned_docs/version-1.0/installation/_category_.json rename to versioned_docs/version-0.24/installation/_category_.json diff --git a/versioned_docs/version-1.0/installation/install-vela.md b/versioned_docs/version-0.24/installation/install-vela.md similarity index 100% rename from versioned_docs/version-1.0/installation/install-vela.md rename to versioned_docs/version-0.24/installation/install-vela.md diff --git a/versioned_docs/version-1.0/installation/server/docker.md b/versioned_docs/version-0.24/installation/server/docker.md similarity index 100% rename from versioned_docs/version-1.0/installation/server/docker.md rename to versioned_docs/version-0.24/installation/server/docker.md diff --git a/versioned_docs/version-1.0/installation/server/server.md b/versioned_docs/version-0.24/installation/server/server.md similarity index 100% rename from versioned_docs/version-1.0/installation/server/server.md rename to versioned_docs/version-0.24/installation/server/server.md diff --git a/versioned_docs/version-1.0/installation/ui/docker.md b/versioned_docs/version-0.24/installation/ui/docker.md similarity index 100% rename from versioned_docs/version-1.0/installation/ui/docker.md rename to versioned_docs/version-0.24/installation/ui/docker.md diff --git a/versioned_docs/version-1.0/installation/ui/ui.md b/versioned_docs/version-0.24/installation/ui/ui.md similarity index 100% rename from versioned_docs/version-1.0/installation/ui/ui.md rename to versioned_docs/version-0.24/installation/ui/ui.md diff --git a/versioned_docs/version-1.0/installation/worker/docker.md b/versioned_docs/version-0.24/installation/worker/docker.md similarity index 100% rename from versioned_docs/version-1.0/installation/worker/docker.md rename to versioned_docs/version-0.24/installation/worker/docker.md diff --git a/versioned_docs/version-1.0/installation/worker/worker.md b/versioned_docs/version-0.24/installation/worker/worker.md similarity index 100% rename from versioned_docs/version-1.0/installation/worker/worker.md rename to versioned_docs/version-0.24/installation/worker/worker.md diff --git a/versioned_docs/version-1.0/reference/_category_.json b/versioned_docs/version-0.24/reference/_category_.json similarity index 100% rename from versioned_docs/version-1.0/reference/_category_.json rename to versioned_docs/version-0.24/reference/_category_.json diff --git a/versioned_docs/version-1.0/reference/api/_category_.json b/versioned_docs/version-0.24/reference/api/_category_.json similarity index 100% rename from versioned_docs/version-1.0/reference/api/_category_.json rename to versioned_docs/version-0.24/reference/api/_category_.json diff --git a/versioned_docs/version-1.0/reference/api/admin/_category_.json b/versioned_docs/version-0.24/reference/api/admin/_category_.json similarity index 100% rename from versioned_docs/version-1.0/reference/api/admin/_category_.json rename to versioned_docs/version-0.24/reference/api/admin/_category_.json diff --git a/versioned_docs/version-1.0/reference/api/admin/build-queue.md b/versioned_docs/version-0.24/reference/api/admin/build-queue.md similarity index 100% rename from versioned_docs/version-1.0/reference/api/admin/build-queue.md rename to versioned_docs/version-0.24/reference/api/admin/build-queue.md diff --git a/versioned_docs/version-1.0/reference/api/admin/build.md b/versioned_docs/version-0.24/reference/api/admin/build.md similarity index 100% rename from versioned_docs/version-1.0/reference/api/admin/build.md rename to versioned_docs/version-0.24/reference/api/admin/build.md diff --git a/versioned_docs/version-1.0/reference/api/authentication.md b/versioned_docs/version-0.24/reference/api/authentication.md similarity index 100% rename from versioned_docs/version-1.0/reference/api/authentication.md rename to versioned_docs/version-0.24/reference/api/authentication.md diff --git a/versioned_docs/version-1.0/reference/cli/_category_.json b/versioned_docs/version-0.24/reference/cli/_category_.json similarity index 100% rename from versioned_docs/version-1.0/reference/cli/_category_.json rename to versioned_docs/version-0.24/reference/cli/_category_.json diff --git a/versioned_docs/version-1.0/reference/cli/repo/_category_.json b/versioned_docs/version-0.24/reference/cli/repo/_category_.json similarity index 100% rename from versioned_docs/version-1.0/reference/cli/repo/_category_.json rename to versioned_docs/version-0.24/reference/cli/repo/_category_.json diff --git a/versioned_docs/version-1.0/reference/cli/repo/add.md b/versioned_docs/version-0.24/reference/cli/repo/add.md similarity index 100% rename from versioned_docs/version-1.0/reference/cli/repo/add.md rename to versioned_docs/version-0.24/reference/cli/repo/add.md diff --git a/versioned_docs/version-1.0/reference/yaml/environment.md b/versioned_docs/version-0.24/reference/yaml/environment.md similarity index 100% rename from versioned_docs/version-1.0/reference/yaml/environment.md rename to versioned_docs/version-0.24/reference/yaml/environment.md diff --git a/versioned_docs/version-1.0/reference/yaml/yaml.md b/versioned_docs/version-0.24/reference/yaml/yaml.md similarity index 100% rename from versioned_docs/version-1.0/reference/yaml/yaml.md rename to versioned_docs/version-0.24/reference/yaml/yaml.md diff --git a/versioned_docs/version-1.0/usage/_category_.json b/versioned_docs/version-0.24/usage/_category_.json similarity index 100% rename from versioned_docs/version-1.0/usage/_category_.json rename to versioned_docs/version-0.24/usage/_category_.json diff --git a/versioned_docs/version-1.0/usage/json-schema-support.md b/versioned_docs/version-0.24/usage/json-schema-support.md similarity index 100% rename from versioned_docs/version-1.0/usage/json-schema-support.md rename to versioned_docs/version-0.24/usage/json-schema-support.md diff --git a/versioned_docs/version-1.0/usage/managing-deployments.md b/versioned_docs/version-0.24/usage/managing-deployments.md similarity index 100% rename from versioned_docs/version-1.0/usage/managing-deployments.md rename to versioned_docs/version-0.24/usage/managing-deployments.md diff --git a/versioned_docs/version-1.0/usage/plugins/plugins.md b/versioned_docs/version-0.24/usage/plugins/plugins.md similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/plugins.md rename to versioned_docs/version-0.24/usage/plugins/plugins.md diff --git a/versioned_docs/version-1.0/usage/plugins/registry/_category_.json b/versioned_docs/version-0.24/usage/plugins/registry/_category_.json similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/registry/_category_.json rename to versioned_docs/version-0.24/usage/plugins/registry/_category_.json diff --git a/versioned_docs/version-1.0/usage/plugins/registry/ansible.md b/versioned_docs/version-0.24/usage/plugins/registry/ansible.md similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/registry/ansible.md rename to versioned_docs/version-0.24/usage/plugins/registry/ansible.md diff --git a/versioned_docs/version-1.0/usage/plugins/registry/vault.md b/versioned_docs/version-0.24/usage/plugins/registry/vault.md similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/registry/vault.md rename to versioned_docs/version-0.24/usage/plugins/registry/vault.md diff --git a/versioned_docs/version-1.0/usage/plugins/tutorials/_category_.json b/versioned_docs/version-0.24/usage/plugins/tutorials/_category_.json similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/tutorials/_category_.json rename to versioned_docs/version-0.24/usage/plugins/tutorials/_category_.json diff --git a/versioned_docs/version-1.0/usage/plugins/tutorials/bash.md b/versioned_docs/version-0.24/usage/plugins/tutorials/bash.md similarity index 100% rename from versioned_docs/version-1.0/usage/plugins/tutorials/bash.md rename to versioned_docs/version-0.24/usage/plugins/tutorials/bash.md diff --git a/versioned_docs/version-1.0/usage/quickstart.md b/versioned_docs/version-0.24/usage/quickstart.md similarity index 100% rename from versioned_docs/version-1.0/usage/quickstart.md rename to versioned_docs/version-0.24/usage/quickstart.md diff --git a/versioned_docs/version-1.1/installation/_category_.json b/versioned_docs/version-0.25/installation/_category_.json similarity index 100% rename from versioned_docs/version-1.1/installation/_category_.json rename to versioned_docs/version-0.25/installation/_category_.json diff --git a/versioned_docs/version-1.1/installation/install-vela.md b/versioned_docs/version-0.25/installation/install-vela.md similarity index 100% rename from versioned_docs/version-1.1/installation/install-vela.md rename to versioned_docs/version-0.25/installation/install-vela.md diff --git a/versioned_docs/version-1.1/installation/server/docker.md b/versioned_docs/version-0.25/installation/server/docker.md similarity index 100% rename from versioned_docs/version-1.1/installation/server/docker.md rename to versioned_docs/version-0.25/installation/server/docker.md diff --git a/versioned_docs/version-1.1/installation/server/kubernetes.md b/versioned_docs/version-0.25/installation/server/kubernetes.md similarity index 100% rename from versioned_docs/version-1.1/installation/server/kubernetes.md rename to versioned_docs/version-0.25/installation/server/kubernetes.md diff --git a/versioned_docs/version-1.1/installation/server/server.md b/versioned_docs/version-0.25/installation/server/server.md similarity index 100% rename from versioned_docs/version-1.1/installation/server/server.md rename to versioned_docs/version-0.25/installation/server/server.md diff --git a/versioned_docs/version-1.1/installation/ui/docker.md b/versioned_docs/version-0.25/installation/ui/docker.md similarity index 100% rename from versioned_docs/version-1.1/installation/ui/docker.md rename to versioned_docs/version-0.25/installation/ui/docker.md diff --git a/versioned_docs/version-1.1/installation/ui/kubernetes.md b/versioned_docs/version-0.25/installation/ui/kubernetes.md similarity index 100% rename from versioned_docs/version-1.1/installation/ui/kubernetes.md rename to versioned_docs/version-0.25/installation/ui/kubernetes.md diff --git a/versioned_docs/version-1.1/installation/ui/ui.md b/versioned_docs/version-0.25/installation/ui/ui.md similarity index 100% rename from versioned_docs/version-1.1/installation/ui/ui.md rename to versioned_docs/version-0.25/installation/ui/ui.md diff --git a/versioned_docs/version-1.1/installation/worker/docker.md b/versioned_docs/version-0.25/installation/worker/docker.md similarity index 100% rename from versioned_docs/version-1.1/installation/worker/docker.md rename to versioned_docs/version-0.25/installation/worker/docker.md diff --git a/versioned_docs/version-1.1/installation/worker/kubernetes.md b/versioned_docs/version-0.25/installation/worker/kubernetes.md similarity index 100% rename from versioned_docs/version-1.1/installation/worker/kubernetes.md rename to versioned_docs/version-0.25/installation/worker/kubernetes.md diff --git a/versioned_docs/version-1.1/installation/worker/worker.md b/versioned_docs/version-0.25/installation/worker/worker.md similarity index 100% rename from versioned_docs/version-1.1/installation/worker/worker.md rename to versioned_docs/version-0.25/installation/worker/worker.md diff --git a/versioned_docs/version-1.1/reference/_category_.json b/versioned_docs/version-0.25/reference/_category_.json similarity index 100% rename from versioned_docs/version-1.1/reference/_category_.json rename to versioned_docs/version-0.25/reference/_category_.json diff --git a/versioned_docs/version-1.1/reference/api/_category_.json b/versioned_docs/version-0.25/reference/api/_category_.json similarity index 100% rename from versioned_docs/version-1.1/reference/api/_category_.json rename to versioned_docs/version-0.25/reference/api/_category_.json diff --git a/versioned_docs/version-1.1/reference/api/admin/_category_.json b/versioned_docs/version-0.25/reference/api/admin/_category_.json similarity index 100% rename from versioned_docs/version-1.1/reference/api/admin/_category_.json rename to versioned_docs/version-0.25/reference/api/admin/_category_.json diff --git a/versioned_docs/version-1.1/reference/api/admin/build-queue.md b/versioned_docs/version-0.25/reference/api/admin/build-queue.md similarity index 100% rename from versioned_docs/version-1.1/reference/api/admin/build-queue.md rename to versioned_docs/version-0.25/reference/api/admin/build-queue.md diff --git a/versioned_docs/version-1.1/reference/api/admin/build.md b/versioned_docs/version-0.25/reference/api/admin/build.md similarity index 100% rename from versioned_docs/version-1.1/reference/api/admin/build.md rename to versioned_docs/version-0.25/reference/api/admin/build.md diff --git a/versioned_docs/version-1.1/reference/api/authentication.md b/versioned_docs/version-0.25/reference/api/authentication.md similarity index 100% rename from versioned_docs/version-1.1/reference/api/authentication.md rename to versioned_docs/version-0.25/reference/api/authentication.md diff --git a/versioned_docs/version-1.1/reference/cli/_category_.json b/versioned_docs/version-0.25/reference/cli/_category_.json similarity index 100% rename from versioned_docs/version-1.1/reference/cli/_category_.json rename to versioned_docs/version-0.25/reference/cli/_category_.json diff --git a/versioned_docs/version-1.1/reference/cli/repo/_category_.json b/versioned_docs/version-0.25/reference/cli/repo/_category_.json similarity index 100% rename from versioned_docs/version-1.1/reference/cli/repo/_category_.json rename to versioned_docs/version-0.25/reference/cli/repo/_category_.json diff --git a/versioned_docs/version-1.1/reference/cli/repo/add.md b/versioned_docs/version-0.25/reference/cli/repo/add.md similarity index 100% rename from versioned_docs/version-1.1/reference/cli/repo/add.md rename to versioned_docs/version-0.25/reference/cli/repo/add.md diff --git a/versioned_docs/version-1.1/reference/yaml/environment.md b/versioned_docs/version-0.25/reference/yaml/environment.md similarity index 100% rename from versioned_docs/version-1.1/reference/yaml/environment.md rename to versioned_docs/version-0.25/reference/yaml/environment.md diff --git a/versioned_docs/version-1.1/reference/yaml/yaml.md b/versioned_docs/version-0.25/reference/yaml/yaml.md similarity index 100% rename from versioned_docs/version-1.1/reference/yaml/yaml.md rename to versioned_docs/version-0.25/reference/yaml/yaml.md diff --git a/versioned_docs/version-1.1/usage/_category_.json b/versioned_docs/version-0.25/usage/_category_.json similarity index 100% rename from versioned_docs/version-1.1/usage/_category_.json rename to versioned_docs/version-0.25/usage/_category_.json diff --git a/versioned_docs/version-1.1/usage/json-schema-support.md b/versioned_docs/version-0.25/usage/json-schema-support.md similarity index 100% rename from versioned_docs/version-1.1/usage/json-schema-support.md rename to versioned_docs/version-0.25/usage/json-schema-support.md diff --git a/versioned_docs/version-1.1/usage/managing-deployments.md b/versioned_docs/version-0.25/usage/managing-deployments.md similarity index 100% rename from versioned_docs/version-1.1/usage/managing-deployments.md rename to versioned_docs/version-0.25/usage/managing-deployments.md diff --git a/versioned_docs/version-1.1/usage/plugins/plugins.md b/versioned_docs/version-0.25/usage/plugins/plugins.md similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/plugins.md rename to versioned_docs/version-0.25/usage/plugins/plugins.md diff --git a/versioned_docs/version-1.1/usage/plugins/registry/_category_.json b/versioned_docs/version-0.25/usage/plugins/registry/_category_.json similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/registry/_category_.json rename to versioned_docs/version-0.25/usage/plugins/registry/_category_.json diff --git a/versioned_docs/version-1.1/usage/plugins/registry/ansible.md b/versioned_docs/version-0.25/usage/plugins/registry/ansible.md similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/registry/ansible.md rename to versioned_docs/version-0.25/usage/plugins/registry/ansible.md diff --git a/versioned_docs/version-1.1/usage/plugins/registry/vault.md b/versioned_docs/version-0.25/usage/plugins/registry/vault.md similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/registry/vault.md rename to versioned_docs/version-0.25/usage/plugins/registry/vault.md diff --git a/versioned_docs/version-1.1/usage/plugins/tutorials/_category_.json b/versioned_docs/version-0.25/usage/plugins/tutorials/_category_.json similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/tutorials/_category_.json rename to versioned_docs/version-0.25/usage/plugins/tutorials/_category_.json diff --git a/versioned_docs/version-1.1/usage/plugins/tutorials/bash.md b/versioned_docs/version-0.25/usage/plugins/tutorials/bash.md similarity index 100% rename from versioned_docs/version-1.1/usage/plugins/tutorials/bash.md rename to versioned_docs/version-0.25/usage/plugins/tutorials/bash.md diff --git a/versioned_docs/version-1.1/usage/quickstart.md b/versioned_docs/version-0.25/usage/quickstart.md similarity index 100% rename from versioned_docs/version-1.1/usage/quickstart.md rename to versioned_docs/version-0.25/usage/quickstart.md diff --git a/versioned_sidebars/version-1.0-sidebars.json b/versioned_sidebars/version-0.24-sidebars.json similarity index 100% rename from versioned_sidebars/version-1.0-sidebars.json rename to versioned_sidebars/version-0.24-sidebars.json diff --git a/versioned_sidebars/version-1.1-sidebars.json b/versioned_sidebars/version-0.25-sidebars.json similarity index 100% rename from versioned_sidebars/version-1.1-sidebars.json rename to versioned_sidebars/version-0.25-sidebars.json diff --git a/versions.json b/versions.json index a74314c..6489229 100644 --- a/versions.json +++ b/versions.json @@ -1,4 +1,4 @@ [ - "1.1", - "1.0" + "0.25", + "0.24" ]