Introduction

This repo contains the source code of kubeblocks docs. It's built by Next.js project bootstrapped with create-next-app, and you can use MUI components directly in mdx files.

Getting Started

Requirements:

• Install Node.js version >= 20.0.0, which can be checked by running node -v.
• yarn

First, run the development server:

yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the docs by modifying /docs. The page auto-updates as you edit the file.

The structure of files

kubeblocks-docs
└─blogs
│  └─en
│  │  │ blog_1.mdx
│  │  │ blog_2.mdx
│  │  │ ...
│
└─docs
│  └─ en
│  │  └─ preview
│  │  │    └─<topbar_category>
│  │  │        └─<sidebar_menu_1>
│  │  │        │    │ doc_1.mdx
│  │  │        │    │ doc_2.mdx
│  │  │        └─<sidebar_menu_2>
│  │  │             │ doc_1.mdx
│  │  │             │ doc_2.mdx
│  │  │
│  │  └─ release-0.9
└─reports                         # kubeblocks reports
│
└─publics
│   └──img                        # markdown assets
│
└─src                             # source code for enginer
│   └─app
│   └─components
│   └─locales
|   └─theme
│   └─...
│
│ README.md
│ packages.json
│ next.config.ts

Deploy

build

make docker-build TAG=main

docker run --name kubeblocks-docs -p 3000:3000 apecloud/kubeblocks-docs:main

deploy & upgrade

helm upgrade --install kubeblocks-docs ./helm/kubeblocks-docs --set image.tag=main --set service.type=LoadBalancer --create-namespace -n kubeblocks-docs

kubectl port-forward svc/kubeblocks-docs 3000:3000 -n kubeblocks-docs