正在加载

参与文档贡献

Elastic Stack 已停止维护 8.18.0

Beats 文档遵循 Docs HOWTO 中描述的标记指南。 然而，它在几个方面扩展了这些功能

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

由于 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
  • heartbeat/docs/fields.asciidoc
  • metricbeat/docs/fields.asciidoc
  • packetbeat/docs/fields.asciidoc
  • winlogbeat/docs/fields.asciidoc
© . All rights reserved.