中文版 ｜ English
DaoCloud 是经认证的 K8s 服务提供商。目前 DCE 经 CNCF 认证可以完美支持以下版本：
K8s 官方维护的当前 4 个版本：
K8s 官方不再维护（但 DaoCloud KLTS 会持续维护）的历史版本：
本文档站采用 MkDocs 编译而成，文档内容通过 Markdown 格式写作，并在 GitHub 上完成版本管理、协作开发等工作。
通过 Pull Request (PR) 的方式提交文档修改、译文或新编内容。
- 点击
Fork按钮创建一个 Fork - 运行
git clone克隆这个 Fork - 本地编辑文档，本地预览
- 依次运行
git add,git commit,git push提交文档 - 进入本 repo 页面发起 PR
- PR 评审后成功合并，谢谢。
本节说明如何在你的本机上预览修改效果。
- 需要本地安装好 Docker，启动 Docker
- 运行
make serve
参阅 MkDocs 官方安装文档。
- 安装开发环境： Poetry 和 Python 3.9 以上
- 配置 poetry:
poetry config virtualenvs.in-project true - 开启 venv:
poetry env use 3.9
- 配置 poetry:
- 安装基础依赖：
poetry install - 启动项目
poetry run mkdocs serve -f mkdocs.yml - 访问本地 http://0.0.0.0:8000/
此处列出一些文件、文件夹的命名规范，便于大家贡献和协作。
- 仅包含英文 小写 字母和连字符（
-） - 禁止包含除英文小写字母和连字符之外的其他符号，例如：
- 中文字符
- 空格
- 特殊字符：
*,?,\,/,:,#,%,~,{,}
- 单词之间用 连字符
-连接 - 尽量简短：建议不超过 5 个英文单词，避免重复冗余信息，可使用常见的英文缩写
- 易于识别：文件名应能描述文档的主题和内容
| 不建议 | 建议 | 原因 |
|---|---|---|
| ConfigName | config-name | 应使用英文小写字母与连字符 |
| 创建 秘钥 | create-secret | 不要使用中文和空格、宏符号等 |
| quick-start-install-online-install | online-install | 文档名应简短 |
| c-ws | create-workspace | 文档名应清晰易懂 |
| update_config | update-config | 用连字符连接单词 |
- 使用 4 个空格的缩进（一个 tab 键）
- 中英字符之间 1 个空格
- 段前段后分别空一行，包括图片前后、嵌套列表前后
- 标题尾部不要加标点符号
- 请勿使用空链接、死链接
- 标题层级依次增加，不要跳级
在修改文档时，请参阅 DaoCloud 的文档书写规范。
技术支持：[email protected]
扫描二维码与开发者畅快交流：
- 文档站发布说明 v1.0
- DaoCloud 文档编写风格
- 社区贡献指南
- 社区行为准则
- 导出 Word 和 PDF
- 页面自动翻译；推荐使用质量更高的 ChatGPT 翻译