内容摘录
DaoCloud Enterprise 5.0 Documentation
Contributors
Build
中文版 ｜ English
DaoCloud is a Certified Kubernetes Service Provider (KCSP). DCE has been certified with the following releases:
Current releases maintained by K8s community:
1.29
1.30
1.31
1.32
Legacy versions that are no longer maintained by the K8s community but will continue to be maintained by DaoCloud's KLTS:
1.7
1.9
1.13
1.15
1.18
1.20
1.23
1.24
1.25
1.26
1.27
1.28
DCE 5.0 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.
Click Fork to create a fork
Run git clone to clone this fork to your computer
Edit one or more pages locally and preview it
Run git commands, such as git add, git commit, and git push, to submit your changes
Open a PR in this repo
Successfully merge after reviewing, thanks.
Preview locally
This section describes how you can preview your changes before commit.
With Docker
Install and run Docker.
Run make serve and preview your changes.
With Git repo
See MkDocs documents to install。
Install Poetry and Python 3.9+
Configure Poetry: poetry config virtualenvs.in-project true
Enable venv: poetry env use 3.9
Install dependencies: poetry install
Run poetry run mkdocs serve -f mkdocs.yml in the repo folder locally
Preview with <http://0.0.0.0:8000/>
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
docs.daocloud.io Release v1.0
DaoCloud Style Guide of Writing
Contribution Guideline
Citizen Code of Conduct
Export Word and PDF
Automatic Page Translation; ChatGPT is recommended to use for better translation
Thanks to all contributors ❤
<a href="https://github.com/daocloud/daocloud-docs/graphs/contributors">
<img src="https://contrib.rocks/image?repo=daocloud/daocloud-docs" />
</a>
Proudly using Netlify
Netlify
| Site | Status
|------|-------
| daocloud-docs | Netlify Status