« 贡献 Beats 测试 »
Elastic 文档 ›Beats 开发者指南 [master] ›贡献 Beats

贡献文档

编辑

贡献文档编辑

Beats 文档遵循 Docs HOWTO 中描述的标签指南。但是，它在一些方面扩展了这些功能。

  • 文档广泛使用 AsciiDoc 条件语句 来提供跨多个书籍重复使用的内容。这意味着每个已发布的 HTML 页面可能没有单个源文件。一些文件在多个书籍中共享，无论是完整的页面还是片段。有关更多详细信息，请参考 Beats 文档源代码的位置。
  • 文档包含一些从 YAML 源代码生成或从代码下的 _meta 目录（例如，模块和导出字段文档）中组合在一起的内容生成的的文件。有关更多详细信息，请参考 生成的文档。

Beats 文档源代码的位置编辑

由于 Beats 文档使用共享内容、文档生成脚本和组件化，因此源文件位于多个位置。

文档 源文件位置

Beat 的主要文档，包括索引文件

<beatname>/docs

共享文档和 Beats 平台参考

libbeat/docs

处理器文档

docs 文件夹位于 libbeat/processors/、x-pack/<beatname>/processors/ 和 x-pack/libbeat/processors/ 下的处理器中

输出文档

docs 文件夹位于 libbeat/outputs/ 下的输出中

模块文档

_meta 文件夹位于 libbeat/module/、<beatname>/module/ 和 x-pack/<beatname>/module/ 下的模块和数据集中

docs 仓库中的 conf.yaml 文件显示了用于构建每本书籍的所有资源。此文件用于驱动经典文档构建，并且是文件位置的真实来源。

如果您找不到要更新的页面的源代码，请访问 www.elastic.co 上已发布的页面，然后单击“编辑”链接以导航到源代码。

Beats 文档构建还依赖于 docs 仓库中的以下文件。

  • shared/versions/stack/<version>.asciidoc
  • shared/attributes.asciidoc

生成的文档编辑

更新 _meta 目录下的 docs.asciidoc 文件后，您必须运行文档收集器脚本以重新生成文档。

确保您设置 Beats 开发环境 并使用正确的 Go 版本。Go 版本列在您要更新的分支的 version.asciidoc 文件中。

要运行文档收集器脚本，请切换到 beats 目录并运行

make update

make update 命令会覆盖 docs 目录中的文件 不会发出警告。如果您不小心更新了生成的文件并运行 make update，您的更改将被覆盖。

要格式化您的文件，您可能还需要运行以下命令

make fmt

make 命令调用以下脚本以生成文档。

auditbeat/scripts/docs_collector.py 生成

  • auditbeat/docs/modules_list.asciidoc
  • auditbeat/docs/modules/*.asciidoc

filebeat/scripts/docs_collector.py 生成

  • filebeat/docs/modules_list.asciidoc
  • filebeat/docs/modules/*.asciidoc

metricbeat/scripts/mage/docs_collector.go 生成

  • metricbeat/docs/modules_list.asciidoc
  • metricbeat/docs/modules/*.asciidoc

libbeat/scripts/generate_fields_docs.py 生成

  • auditbeat/docs/fields.asciidoc
  • filebeat/docs/fields.asciidoc
  • functionbeat/docs/fields.asciidoc
  • heartbeat/docs/fields.asciidoc
  • metricbeat/docs/fields.asciidoc
  • packetbeat/docs/fields.asciidoc
  • winlogbeat/docs/fields.asciidoc
« 贡献 Beats 测试 »