文档基础知识

Choerodon文档使用Markdown编写，并使用Hugo进行处理和部署。

源代码位于Github 大多数文档源都存储在

您可以从Github网站上提交问题，编辑内容和查看其他人的更改。

  • 专有名词英文首字母大写

  • 不要出现大面积文字，应文字，图片，注意事项，表格，列表均匀排布，提高阅读效率

  • 对用户界面元素使用粗体

  • 将读者称为”您“

  • 避免使用”我们“

在句子中使用“我们”可能会令人困惑，因为读者可能不知道他们是否是您所描述的“我们”的一部分。

页面模板

  • 子目录缩略

需要在当前文档页中显示子目录连接及其简介时使用{{< docdir >}}

目录结构：

举例如下：

  1. {{< docdir >}}

最终显示：

功能

需要在代码块中添加注释时，可以使用{{< annotation >}}短代码。

举例如下：

最终显示：

  1.                 
  2.                                 
        kubectl exec -it [mysql pod name] -n choerodon-devops-prod bash 
  3.                                 
  4.                             
  5.

[mysql pod name]Replace it with the name of the container you want to enter

  • 注意及警告

对于HTML文档中的注意及警告，请使用{{< note >}}和标记。

  1. {{< warning >}}Beware.{{< /warning >}}

最终显示：

  • 表格样式

表格需要设置列不换行时，使用{{< table >}}短代码

举例如下：

设置角色和层级列不换行

最终显示：

角色 权限 层级 项目所有者 项目角色分配、项目信息、应用管理、分支管理、持续集成、应用版本、应用发布、应用市场（仅查看）、环境管理（仅查看）、应用部署（仅查看）、网络管理（仅查看）、域名管理（仅查看）、容器管理 项目层 项目成员 应用管理（仅查看）、分支管理（仅有developer权限）、持续集成、应用版本、应用发布（仅查看）、应用市场（仅查看）、环境管理（仅查看）、应用部署（仅查看）、网络管理（仅查看）、域名管理（仅查看）、容器管理 项目层 部署管理员 应用市场、环境管理、应用部署、网络管理、域名管理、容器管理 项目层

任何拥有Github帐户的人都可以针对Choerodon文档提出问题（错误报告）。如果您发现错误，即使您不知道如何修复它，也应提出问题。

  • 附加出现问题的文档链接。
  • 详细描述问题。
  • 提出建议修复的方式

提交案例

案例研究强调了组织如何使用Choerodon解决实际问题。它们与Choerodon运营团队合作编写。

看看现有案例研究的来源 。