From 48183d62fd06a7d9ca5b7270dcdc02e317f090d1 Mon Sep 17 00:00:00 2001 From: dedemorton Date: Wed, 3 Nov 2021 12:39:31 -0700 Subject: [PATCH 1/2] Add note that there is no warranty or support for generator code --- docs/devguide/create-metricset.asciidoc | 2 ++ docs/devguide/generator-support-note.asciidoc | 20 +++++++++++++++++++ docs/devguide/modules-dev-guide.asciidoc | 2 ++ 3 files changed, 24 insertions(+) create mode 100644 docs/devguide/generator-support-note.asciidoc diff --git a/docs/devguide/create-metricset.asciidoc b/docs/devguide/create-metricset.asciidoc index a1540be2384..fd60e25dd3a 100644 --- a/docs/devguide/create-metricset.asciidoc +++ b/docs/devguide/create-metricset.asciidoc @@ -1,6 +1,8 @@ [[creating-metricsets]] === Creating a Metricset +include::generator-support-note.asciidoc[tag=metricset-generator] + A metricset is the part of a Metricbeat module that fetches and structures the data from the remote service. Each module can have multiple metricsets. In this guide, you learn how to create your own metricset. diff --git a/docs/devguide/generator-support-note.asciidoc b/docs/devguide/generator-support-note.asciidoc new file mode 100644 index 00000000000..ecce457487a --- /dev/null +++ b/docs/devguide/generator-support-note.asciidoc @@ -0,0 +1,20 @@ +// tag::beat-generator[] +IMPORTANT: Elastic provides no warranty or support for the code used to generate +a Beat. The Beat generator is mainly offered as guidance for developers who want +to create their own data shippers. + +// end::beat-generator[] + +// tag::metricset-generator[] +IMPORTANT: Elastic provides no warranty or support for the code used to generate +metricsets. The generator is mainly offered as guidance for developers who want +to create their own data shippers. + +// end::metricset-generator[] + +// tag::filebeat-generator[] +IMPORTANT: Elastic provides no warranty or support for the code used to generate +modules and filesets. The generator is mainly offered as guidance for developers +who want to create their own data shippers. + +// end::filebeat-generator[] \ No newline at end of file diff --git a/docs/devguide/modules-dev-guide.asciidoc b/docs/devguide/modules-dev-guide.asciidoc index 0936438900e..03b3179c596 100644 --- a/docs/devguide/modules-dev-guide.asciidoc +++ b/docs/devguide/modules-dev-guide.asciidoc @@ -1,6 +1,8 @@ [[filebeat-modules-devguide]] == Creating a New Filebeat Module +include::generator-support-note.asciidoc[tag=filebeat-generator] + This guide will walk you through creating a new Filebeat module. All Filebeat modules currently live in the main From 9c1c9d8660219e9cf1832925b264652ddbf22e28 Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Wed, 10 Nov 2021 11:40:31 -0800 Subject: [PATCH 2/2] Remove tagged region because it's no longer used --- docs/devguide/generator-support-note.asciidoc | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/devguide/generator-support-note.asciidoc b/docs/devguide/generator-support-note.asciidoc index ecce457487a..25579798ed2 100644 --- a/docs/devguide/generator-support-note.asciidoc +++ b/docs/devguide/generator-support-note.asciidoc @@ -1,10 +1,3 @@ -// tag::beat-generator[] -IMPORTANT: Elastic provides no warranty or support for the code used to generate -a Beat. The Beat generator is mainly offered as guidance for developers who want -to create their own data shippers. - -// end::beat-generator[] - // tag::metricset-generator[] IMPORTANT: Elastic provides no warranty or support for the code used to generate metricsets. The generator is mainly offered as guidance for developers who want