« 贡献于 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
  • heartbeat/docs/fields.asciidoc
  • metricbeat/docs/fields.asciidoc
  • packetbeat/docs/fields.asciidoc
  • winlogbeat/docs/fields.asciidoc
« 贡献于 Beats 测试 »