Profile
Back to NewsBack
GitHub Trending 3 min
Reader Mode
DaoCloud/DaoCloud-docs: DaoCloud Documentation

DaoCloud/DaoCloud-docs: DaoCloud Documentation

4 hours ago

DaoCloud Docs Hub

Contributors</a> Build</a>

中文版 | English

DaoCloud is a certified Kubernetes and AI service provider.

  • Its products have passed CNCF AI Conformance certification to support the following Kubernetes versions:
1.35</a> 1.34</a> 1.33</a>
  • Its products have passed CNCF Conformance certification to support the following Kubernetes versions:
1.36</a> 1.35</a> 1.34</a> 1.33</a> 1.32</a> 1.31</a> 1.30</a> 1.29</a> 1.28</a> 1.27</a> 1.26</a> 1.25</a> 1.24</a> 1.23</a> 1.20</a> 1.18</a> 1.15</a> 1.13</a> 1.9</a> 1.7</a>
Legacy versions that are no longer maintained by the K8s community but will continue to be maintained by DaoCloud's KLTS.
> This website is created with MkDocs. All pages are written in markdown. We use GitOps to control workflow and versions.

Open a PR

This website uses Pull Request (PR) to modify, translate, and manage all pages.

  1. Click Fork to create a fork
  2. Run git clone to clone this fork to your computer
  3. Edit one or more pages locally and preview it
  4. Run git commands, such as git add, git commit, and git push, to submit your changes
  5. Open a PR in this repo
  6. Successfully merge after reviewing, thanks.

Preview locally

This section describes how you can preview your changes before commit.

With Docker

  1. Install and run Docker.
  2. Run make serve-docker and preview your changes.

With Git repo

See MkDocs documents to install。

  1. Install uv.
  2. Install dependencies: uv sync
  3. Preview Chinese docs: make serve zh
  4. Preview English docs: make serve en
  5. Build both sites: make build all
  6. Preview with

Naming conventions

This section lists some conventions about a file or folder name for your reference:

  • Only contain English lower cases and hyphens (-)
  • Do not contain any of these characters like:
- Chinese chars - spaces - special chars like *, ?, \, /, :, #, %, ~, {, }
  • Connect words with a hyphen (-)
  • Keep short:up to 5 English words, avoid repetition, use abbreviations
  • Be descriptive: easy to understand and reflect the doc's subject
| No | Yes | Why | | ---------------------------------- | ---------------- | ---------------------------------------- | | ConfigName | config-name | Use small letters and hyphens | | create secret | create-secret | No spaces in name | | quick-start-install-online-install | online-install | Keep short | | c-ws | create-workspace | Be descriptive | | update_image | update-image | Connect words with hyphens |

Tips about writing

  • Indent 4 spaces for bullets
  • Provide a space between zh and en chars
  • Provide a blank line before and after a para, an image, a heading, or a list
  • Do not add any punctuation by the end of a heading
  • Care about links to avoid any null or dead link
  • Give a consistent experience to explore all pages herein
For more details refer to DaoCloud Style Guide of Writing.

References

Thanks to all contributors ❤

Proudly using Netlify

Netlify</a>

| Site | Status |------|------- | daocloud-docs | Netlify Status</a>

Chat with me