开发期间的文档

编辑

文档应在开发期间编写,并在相关时随 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