Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 2.7 KB
Raw

Contributing to GreptimeDB Docs

File Structure

This project uses markdown files to generate a documentation website. All markdown files are located in the docs directory.

  • The version directories in /docs match the GreptimeDB version. For example, /docs/v0.4 contains the documentation for GreptimeDB v0.4.
  • The file summary.yml defines the navigation of the documentation website. It should match the current document structure. You need to use - and lowercase letters in markdown file names so that summary.yml can recognize these file names.

Document Localization

  • The localized documentation is located in the /docs/xx directory, where xx is the language code.
  • The summary-i18n.yml file in the /docs/xx directory defines the navigation of the localized documentation website. The content in summary-i18n.yml should be the localized name of the relative directory. If you add a new directory in /docs/xx, remember to update summary-i18n.yml.

Links

  • Use relative paths for internal links whenever possible.
  • Reference files placed in public using root absolute path - for example, public/icon.png should always be referenced in source code as /icon.png.

Style Guide

Please use example.drawio.svg as a template for drawing diagrams. You can install the Draw.io Integration for VS Code and create a new diagram from the template.

If there is no suitable graphics, you can use other graphics, but the colors should be consistent with the template.

Markdown Lint

We use markdownlint-cli to check format of markdown files. You can do it locally with:

markdownlint -c .markdownlint.yaml **/*.md

You can also use markdownlint extension if you are using VS Code.

Build and preview the docs locally

We highly encourage you to preview your changes locally before submitting a pull request. This project requires Node.js version 18.0.0 or higher. Use the following commands to start a local server:

npm install
npm run dev

You can also use npm run build to check dead links.

Preview the Localized documentation

To preview the documentation in a specific language, add a new file called .env to the root directory and include the VITE_LANG=xx environment variable, where xx is the language code. For example, to preview the Chinese documentation, add the following content to .env:

VITE_LANG=zh

Then start a local server with npm run dev.

PR Title Check

We require pull request title to start with these keywords