docs: initial changes to content and config for docusaurus (#1)

Added Docusaurus config for the new docs repo

Signed-off-by: ANUSHKA SAXENA <[email protected]>
Signed-off-by: ANUSHKA SAXENA <[email protected]>
Signed-off-by: Gabriele Bartolini <[email protected]>
Co-authored-by: Gabriele Bartolini <[email protected]>
Signed-off-by: Gabriele Bartolini <[email protected]>

Author: SaxenaAnushka102

.gitignore

@@ -24,7 +24,44 @@
 *~
 
 # Dependency directories (remove the comment below to include it)
+node_modules/
 # vendor/
 
 # Go workspace file
 go.work
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+yarn.lock
+
+# Build and cache
+.cache/
+.docusaurus/
+build/
+
+# Dependency dirs
+node_modules/
+node_modules copy/
+
+# IDE
+.vscode/
+.idea/
+
+# Misc
+.DS_Store

README.md

@@ -12,7 +12,7 @@ managing PostgreSQL workloads on Kubernetes from the CNCF.
 ## LFX Mentorship 2025/3
 
 This repository is part of the [LFX Mentorship 2025/3](https://mentorship.lfx.linuxfoundation.org/project/86a647c1-88c7-474f-b093-6abb58197083)
-programme, with **Anushka Agarwal** as the mentee.
+programme, with **Anushka Saxena** as the mentee.
 For more details, see [cloudnative-pg/cloudnative-pg#8122](https://github.com/cloudnative-pg/cloudnative-pg/issues/8122).
 
 ---
@@ -33,7 +33,47 @@ and make sure your work aligns with the project’s values and goals.
 
 ## Building the Documentation
 
-TODO
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
 
 ---
 

convert-frontmatter.js

@@ -0,0 +1,61 @@
+const fs = require('fs');
+const path = require('path');
+const glob = require('glob');
+
+const DOCS_DIR = path.join(__dirname, 'docs');
+
+// Use glob.sync with forward slashes
+const files = glob.sync(path.join(DOCS_DIR, '**/*.md').replace(/\\/g, '/'));
+
+console.log(`Found ${files.length} markdown files.`);
+
+files.forEach(file => {
+  let content = fs.readFileSync(file, 'utf8');
+
+  // Match frontmatter (--- at start, then anything, then ---)
+  const fmMatch = content.match(/^---\r?\n([\s\S]*?)\r?\n---/);
+  if (fmMatch) {
+    let fmContent = fmMatch[1];
+
+    // Only add id if not present
+    if (!/^id:/m.test(fmContent)) {
+      const titleMatch = fmContent.match(/^\s*title:\s*(.+)$/m);
+      const titleLine = titleMatch ? `title: ${titleMatch[1]}` : '';
+
+      const sidebarMatch = fmContent.match(/^\s*sidebar_position:\s*(.+)$/m);
+      const sidebarLine = sidebarMatch ? `sidebar_position: ${sidebarMatch[1]}` : '';
+
+      // Generate ID from filename (kebab-case)
+      const id = path.basename(file, path.extname(file))
+        .trim()
+        .toLowerCase()
+        .replace(/\s+/g, '-');
+
+      const newFM = ['---', `id: ${id}`, sidebarLine, titleLine, '---']
+        .filter(Boolean)
+        .join('\n');
+
+      const restContent = content.slice(fmMatch[0].length).trimStart();
+      fs.writeFileSync(file, newFM + '\n\n' + restContent, 'utf8');
+
+      console.log(`Updated frontmatter: ${file}`);
+    }
+  } else {
+    // No frontmatter at all
+    const id = path.basename(file, path.extname(file))
+      .trim()
+      .toLowerCase()
+      .replace(/\s+/g, '-');
+    const title = id.replace(/-/g, ' ');
+
+    const newFM = `---
+id: ${id}
+title: ${title}
+---`;
+
+    fs.writeFileSync(file, newFM + '\n\n' + content, 'utf8');
+    console.log(`Added frontmatter: ${file}`);
+  }
+});
+
+console.log('Frontmatter conversion complete.');