Kubeblocks docs website

This repo contains the source code of kubeblocks website. It's built by Docusaurus, a modern static website generator.

Contributing to Kubeblocks EN Docs

First, we have the source documentation in Kubeblocks repo and it's written in English. Any doc files modifid will trigger the Github action to run and validate the docs could be build successfully into the website.

The Github-Action there will parse the document and publish it to the Kubeblocks Website automatically.

Please follow our guides below to learn how to preview the docs in the right way.

How to preview the docs

1. Requirements

• Required: Install Node.js version 16.14 or above (which can be checked by running node -v).

• Optional: Install vscode plugin 'Markdown Snippets for MDX and Docusaurus'.

https://marketplace.visualstudio.com/items?itemName=MisterMunchkin.simple-markdown-snippets

2. Run development server

cd /path/to/kubeblocks.io

yarn install

yarn docs:sync

yarn dev

By default, a browser window opens at http://localhost:3000. Browse the site to see what's available. The default locale is en-us;

3. add anthor version to website

Add a version configuration in config/versions.js, and then execute the command yarn docs:sync again

module.exports = [
  {
    version: "release-0.5",
    branch: "release-0.5",
    sidebar: {
      docs: [{ type: "autogenerated", dirName: "user_docs" }],
      release_notes: [{ type: "autogenerated", dirName: "release_notes" }],
    },
  },
];