docs: use docs-only mode instead of having a landing page (#12)

The landing page is already cloudnative-pg.io, so we don't need another
one. We ensure that the latest release is the one users get when they do
not specify an exact version.

Signed-off-by: Francesco Canovai <[email protected]>

Author: fcanovai

scripts/import_docs.sh

@@ -139,7 +139,7 @@ fi
 
 echo "Updating versions_config.json: version ${VERSION_DIR} banner=${BANNER}"
 jq --arg version "$VERSION_DIR" --arg banner "$BANNER" \
-  '.[$version] = {"badge": true, "banner": $banner}' \
+  '.[$version] = {"badge": true, "banner": $banner, "path": $version}' \
   "$VERSIONS_CONFIG" > "${VERSIONS_CONFIG}.tmp" && \
   mv "${VERSIONS_CONFIG}.tmp" "$VERSIONS_CONFIG"
 
@@ -150,7 +150,7 @@ if [[ "$VERSION_DIR" == "$HIGHEST_VERSION" ]] && [[ "$IS_RC" == false ]]; then
   echo "Version ${VERSION_DIR} is the highest release - updating lastVersion in docusaurus.config.ts"
 
   # Update lastVersion in docusaurus.config.ts
-  sed -i.bak "s/lastVersion: '[^']*'/lastVersion: '${VERSION_DIR}'/" "$DOCUSAURUS_CONFIG" && \
+  sed -i.bak "s/lastVersion = '[^']*'/lastVersion = '${VERSION_DIR}'/" "$DOCUSAURUS_CONFIG" && \
     rm "${DOCUSAURUS_CONFIG}.bak"
 
   echo "Updated lastVersion to ${VERSION_DIR}"

website/docusaurus.config.ts

@@ -6,6 +6,8 @@ import type * as Preset from '@docusaurus/preset-classic';
 
 const versionsConfig = require('./versions_config.json') as Record<string, import('@docusaurus/plugin-content-docs').VersionOptions>;
 
+const lastVersion = '1.28';
+
 const config: Config = {
   title: 'CloudNativePG',
   tagline: 'Run PostgreSQL.The Kubernetes way.',
@@ -47,7 +49,7 @@ const config: Config = {
           sidebarPath: require.resolve('./sidebars.js'),
           routeBasePath: '/',
           includeCurrentVersion: true, // Include the current version in the sidebar
-          lastVersion: '1.28',
+          lastVersion: lastVersion,
           versions: versionsConfig,
         },
         blog: false,
@@ -81,6 +83,7 @@ const config: Config = {
       logo: {
         alt: 'CloudNativePG Logo',
         src: 'img/hero_image.svg',
+        href: 'https://cloudnative-pg.io',
       },
       items: [
         {
@@ -92,7 +95,11 @@ const config: Config = {
         {
             type: 'docsVersionDropdown',
             position: 'right',
-            versions: ['current', '1.28', '1.27'],
+            versions: Object.keys(versionsConfig).sort((a, b) => {
+                if (a === 'current') return -1;
+                if (b === 'current') return 1;
+                return b.localeCompare(a, undefined, { numeric: true });
+            }),
         },
           {
               href: "https://github.com/cloudnative-pg/",
@@ -159,6 +166,19 @@ const config: Config = {
       darkTheme: prismThemes.dracula,
     },
   } satisfies Preset.ThemeConfig,
+  plugins: [
+      [
+          '@docusaurus/plugin-client-redirects',
+          {
+              redirects: [
+                  {
+                      to: `/${lastVersion}/`,
+                      from: '/',
+                  },
+              ],
+          },
+      ],
+  ],
 };
 
 export default config;

website/package.json

@@ -16,6 +16,7 @@
   },
   "dependencies": {
     "@docusaurus/core": "3.9.1",
+    "@docusaurus/plugin-client-redirects": "3.9.1",
     "@docusaurus/preset-classic": "3.9.1",
     "@easyops-cn/docusaurus-search-local": "^0.52.1",
     "@mdx-js/react": "^3.0.0",

website/versions_config.json

@@ -6,10 +6,12 @@
   },
   "1.27": {
     "badge": true,
-    "banner": "none"
+    "banner": "none",
+    "path": "1.27"
   },
   "1.28": {
     "badge": true,
-    "banner": "none"
+    "banner": "none",
+    "path": "1.28"
   }
 }

website/yarn.lock

@@ -1809,6 +1809,21 @@
     react-helmet-async "npm:@slorber/[email protected]"
     react-loadable "npm:@docusaurus/[email protected]"
 
+"@docusaurus/[email protected]":
+  version "3.9.1"
+  resolved "https://registry.yarnpkg.com/@docusaurus/plugin-client-redirects/-/plugin-client-redirects-3.9.1.tgz#06e07487f1596c62536d50afac81535d5fe60a20"
+  integrity sha512-+1InCGvAnw46H+TnVqxaYlJC0qy9AY5gTMgTx2ZFryjAsImJNs3i1pEYW/iUTVbOdtWRj3E/87E4ehbBIaA1TA==
+  dependencies:
+    "@docusaurus/core" "3.9.1"
+    "@docusaurus/logger" "3.9.1"
+    "@docusaurus/utils" "3.9.1"
+    "@docusaurus/utils-common" "3.9.1"
+    "@docusaurus/utils-validation" "3.9.1"
+    eta "^2.2.0"
+    fs-extra "^11.1.1"
+    lodash "^4.17.21"
+    tslib "^2.6.0"
+
 "@docusaurus/[email protected]":
   version "3.9.1"
   resolved "https://registry.yarnpkg.com/@docusaurus/plugin-content-blog/-/plugin-content-blog-3.9.1.tgz#bf6619847065360d52abc5bf1da307f5ce2a19f8"