开发过程中的文档编辑

文档应该在开发过程中编写,并在相关时随 PR 一起提供。有几种类型的文档,以及在不同位置添加它们。

最终用户文档编辑

关于面向用户的功能的文档应该使用 asciidoc 编写,位于 https://github.com/elastic/kibana/tree/main/docs

要构建文档,您必须将 elastic/docs 仓库克隆为 Kibana 仓库的同级目录。按照该项目 README 中的说明设置文档工具。

要构建文档

node scripts/docs.js --open
REST API编辑

REST API 应该使用以下推荐的格式进行文档化

通用开发者文档和指南编辑

通用开发者指南和文档,就像这里一样,应该使用 asciidoc 编写,位于 https://github.com/elastic/kibana/tree/main/docs/developer