/zeebe-docs-zh

工作流引擎 Zeebe 中英文档

Primary LanguageHTML

Zeebe - 中英文档

This module contains the source of the documentation that is published at https://docs.zeebe.io/.

文档发布在 https://zeebe-docs.bingohuang.com。

Building the documentation locally / 在本地构建文档

The documentation is generated by mdbook.

本文档由 mdbook 生成。

  1. Install the latest mdbook version, see installation instructions on GitHub.
    • 安装最新版本的 mdbook，请参阅GitHub
  2. Install the link checking backend for mdbook, see installation instructions on GitHub.
    • 安装 mdbook 的链接检查后端，请参阅GitHub
  3. Go to the docs folder in the Zeebe repository
    • 进入 Zeebe 仓库的 docs 目录
  4. Run the command mdbook serve to start the web server. It will generate the documentation on every change.
    • 运行命令 mdbook serve，启动 Web 服务，每次修改保存服务会自动更新
  5. See the documentation at http://localhost:3000

Writing documentation / 编写文档

The documentation is written in Markdown.

本文档采用 Markdown 语言编写

The important folders/files are:

重要的文件夹/文件有：

  • docs/src - Markdown files grouped by sections + PNG images / 按章节分组的 Markdown 文件和图片
    • SUMMARY.md - the table of content (updated manually) / 章节目录（需手动更新）
  • docs/media-src - BPMN files to create the images from / 用于创建图片的BPMN文件
  • Google Drive - sources of other graphics/diagrams / 其它图形资源

Releasing the documentation / 发布文档

When a pull request is merged to develop then it generates the documentation and publish it to https://stage.docs.zeebe.io/.

提交 PR 到 develop 分支，它会自动生成文档，并发布到 https://zeebe-docs.bingohuang.com。

The documentation is usually published from the stage environment to https://docs.zeebe.io/ during the release. However, it can be manually triggered using the Zeebe CI job if needed.

文档通常会在发布后从稳定环境发布到 https://zeebe-docs.bingohuang.com。当然，如果需要也可以手动触发 Zeebe CI 任务 。