Welcome to the GitHub repository for KubeEdge's public website. The docs are hosted at https://kubeedge.io.
We use Docusaurus to format and generate our website, and Netlify to manage the deployment of the site. Docusaurus is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown, and Docusaurus wraps them up into a website.
Here's a quick guide to updating the docs. It assumes you're familiar with the GitHub workflow and you're happy to use the automated preview of your doc updates:
[WIP]
in your PRs title. You can also add /hold
in a comment to mark the PR as not
ready for merge. If you'd like to preview your doc updates as you work, you can install Node.js and run a local server. This section shows you how.
Node.js version 16.14 or above (which can be checked by running node -v
). You can use nvm for managing multiple Node versions on a single machine installed.
npm install -g yarn
cd website
yarn
$ 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.
Your website is at http://localhost:3000/
$ yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
For each stable release, we should create a new branch for the relevant documentation. For example, the documentation for the v0.1 stable release are maintained in the v0.1-branch. Each branch has a corresponding netlify website that automatically syncs each merged PR.
Going forward, the versioned sites should follow this convention:
https://kubeedge.netlify.com/
always points to the current master branchhttps://master.kubeedge.netlify.com/
always points to Github headhttps://vXXX-YYY.kubeedge.netlify.com/
points to the release at vXXX.YYY-branch