更新版本已发布。有关最新信息，请参阅当前版本文档。
« 贡献 Beats 测试 »
Elastic 文档 ›Beats 开发者指南 [8.14] ›贡献 Beats

参与文档贡献

编辑

参与文档贡献编辑

Beats 文档遵循文档操作指南中描述的标签指南。 然而，它在以下几个方面扩展了这些功能

  • 文档广泛使用了AsciiDoc 条件语句来提供跨多本书籍重用的内容。 这意味着可能没有每个已发布 HTML 页面的单个源文件。 一些文件在多本书籍之间共享，可以是完整的页面，也可以是片段。 有关更多详细信息，请参阅在哪里找到 Beats 文档源代码。
  • 文档包含一些从 YAML 源代码生成或从代码下的 _meta 目录中的内容拼凑而成的文件（例如，模块和导出字段文档）。 有关更多详细信息，请参阅生成的文档。

在哪里找到 Beats 文档源代码编辑

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

文档 源文件位置

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

<beatname>/docs

共享文档和 Beats 平台参考

libbeat/docs

处理器文档

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

输出文档

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

模块文档

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

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 测试 »