中文版 | English
DaoCloud is a Certified Kubernetes Service Provider (KCSP). DCE has been certified with the following releases:
Current releases maintained by K8s community:
Legacy versions that are no longer maintained by the K8s community but will continue to be maintained by DaoCloud's KLTS:
DCE 5.0 website is created with MkDocs. All pages are written in markdown. We use GitOps to control workflow and versions.
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
, andgit push
, to submit your changes - Open a PR in this repo
- Successfully merge after reviewing, thanks.
This section describes how you can preview your changes before commit.
- Install and run Docker.
- Run
make serve
and preview your changes.
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
- Configure Poetry:
- Install dependencies:
poetry install
- Run
poetry run mkdocs serve -f mkdocs.yml
in the repo folder locally - Preview with https://0.0.0.0:8000/
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 |
- 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.
- 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
Site | Status |
---|---|
daocloud-docs |