From d2628c94a1ec6ba8f4c2f6f519655abac7a3dfdc Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 26 Oct 2020 14:35:08 -0500 Subject: [PATCH 01/20] add beta label support --- scripts/templates/field_details.j2 | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index 3eef363fa8..843d6b2393 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -25,7 +25,12 @@ Find additional usage and examples in the {{ fieldset['name'] }} fields < Date: Mon, 26 Oct 2020 14:35:27 -0500 Subject: [PATCH 02/20] document beta field --- schemas/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/schemas/README.md b/schemas/README.md index 39b18f4bd7..9892ee7f5e 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -134,6 +134,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). +- beta (optional): If `True`, the field will be marked in the documentation with a `beta` label. Supported keys to describe expected values for a field From c1cc99ea17f6eb77b0a54d69680ae1d7e8a17fce Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 27 Oct 2020 13:54:40 -0500 Subject: [PATCH 03/20] add changelog --- CHANGELOG.next.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 8ca106a444..6fa34dc167 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -37,6 +37,7 @@ Thanks, you're awesome :-) --> * Added support for `scaled_float`'s mandatory parameter `scaling_factor`. #1042 * Added ability for --oss flag to fall back `constant_keyword` to `keyword`. #1046 * Added support in the generated Go source go for `wildcard`, `version`, and `constant_keyword` data types. #1050 +* Added support for marking fields as beta in the documentation. #1051 * Added support for `constant_keyword`'s optional parameter `value`. #1112 #### Improvements From 2844ec8804f224f9402abc14c40aeb125f569ef3 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Wed, 4 Nov 2020 17:05:56 -0600 Subject: [PATCH 04/20] add support for field reuse and field set beta markers --- scripts/templates/field_details.j2 | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index 843d6b2393..d077eb5c42 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -10,6 +10,13 @@ Find additional usage and examples in the {{ fieldset['name'] }} fields <> beta:[ {{ entry['beta'] }}] +{%- else -%} | <> +{%- endif %} | {{ entry['short'] }} // =============================================================== From 3d7324a956df40f45c5d0f2a8ff79ab543dbdf7a Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Wed, 4 Nov 2020 18:05:32 -0600 Subject: [PATCH 05/20] shift beta marker to description fields --- scripts/templates/field_details.j2 | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/scripts/templates/field_details.j2 b/scripts/templates/field_details.j2 index d077eb5c42..643c2ccf5d 100644 --- a/scripts/templates/field_details.j2 +++ b/scripts/templates/field_details.j2 @@ -32,14 +32,16 @@ beta::[ {{ fieldset['beta'] }}] {% if 'original_fieldset' not in field -%} {# `Field` column -#} -{#- Beta fields will add the `beta` label -#} -{%- if field['beta'] -%} -| {{ field['flat_name'] }} beta:[ {{ field['beta'] }} ] -{%- else -%} | {{ field['flat_name'] }} -{%- endif %} {# `Description` column -#} +{#- Beta fields will add the `beta` label -#} +{% if field['beta'] -%} +| beta:[ {{ field['beta'] }} ] + +{{ field['description']|replace("\n", "\n\n") }} +{%- else -%} | {{ field['description']|replace("\n", "\n\n") }} +{%- endif %} type: {{ field['type'] }} @@ -121,12 +123,15 @@ Note also that the `{{ fieldset['name'] }}` fields are not expected to be used d {% for entry in render_nestings_reuse_section -%} {#- Beta marker on nested fields -#} -{%- if entry['beta'] -%} -| <> beta:[ {{ entry['beta'] }}] -{%- else -%} | <> -{%- endif %} +{#- Beta marker on nested fields -#} +{%- if entry['beta'] -%} +| beta:[ {{ entry['beta'] }}] + +{{ entry['short'] }} +{%- else %} | {{ entry['short'] }} +{%- endif %} // =============================================================== From c8202d7919f2936259d1c2233a7d8c4173725a03 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Wed, 4 Nov 2020 18:06:15 -0600 Subject: [PATCH 06/20] add beta field to reuse_entry --- scripts/generators/asciidoc_fields.py | 3 ++- scripts/schema/finalizer.py | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/scripts/generators/asciidoc_fields.py b/scripts/generators/asciidoc_fields.py index e5e2262bd0..04fd1fcacf 100644 --- a/scripts/generators/asciidoc_fields.py +++ b/scripts/generators/asciidoc_fields.py @@ -39,7 +39,8 @@ def render_nestings_reuse_section(fieldset): rows.append({ 'flat_nesting': "{}.*".format(reused_here_entry['full']), 'name': reused_here_entry['schema_name'], - 'short': reused_here_entry['short'] + 'short': reused_here_entry['short'], + 'beta': reused_here_entry.get('beta', '') }) return sorted(rows, key=lambda x: x['flat_nesting']) diff --git a/scripts/schema/finalizer.py b/scripts/schema/finalizer.py index 3d1c7202b2..68124fc930 100644 --- a/scripts/schema/finalizer.py +++ b/scripts/schema/finalizer.py @@ -128,6 +128,8 @@ def append_reused_here(reused_schema, reuse_entry, destination_schema): 'full': reuse_entry['full'], 'short': reused_schema['field_details']['short'], } + if 'beta' in reuse_entry: + reused_here_entry['beta'] = reuse_entry['beta'] destination_schema['schema_details']['reused_here'].extend([reused_here_entry]) From 4f10674296da45045e8ab3f02f78dbb9ea60ecb7 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 5 Nov 2020 10:47:01 -0600 Subject: [PATCH 07/20] update beta attributes and usage --- schemas/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/schemas/README.md b/schemas/README.md index 9892ee7f5e..432201b354 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -32,6 +32,7 @@ Optional field set attributes: - type (ignored): at this level, should always be `group` - reusable (optional): Used to identify which field sets are expected to be reused in multiple places. See "Field set reuse" for details. +- beta: Adds a beta marker for the entire fieldset. The text provided in this attribute is used as content of the beta marker in the documentation. ### Field set reuse @@ -104,6 +105,8 @@ The above defines all process fields in both places: } ``` +The `beta` marker can also be used along with `at` and `as` to include a beta marker in the documentation containing the provided description. + ### List of fields Array of YAML objects: @@ -134,7 +137,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). -- beta (optional): If `True`, the field will be marked in the documentation with a `beta` label. +- beta: Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Supported keys to describe expected values for a field From 08ff40f8f1183717ce21ef221b128b5807bc40cf Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 5 Nov 2020 10:49:10 -0600 Subject: [PATCH 08/20] improve beta documentation --- schemas/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/schemas/README.md b/schemas/README.md index 432201b354..95e0324fd3 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -105,7 +105,17 @@ The above defines all process fields in both places: } ``` -The `beta` marker can also be used along with `at` and `as` to include a beta marker in the documentation containing the provided description. +The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the documentation containing the provided description. + +``` + reusable: + top_level: true + expected: + - at: user + as: target + beta: > + Beta description text here. +``` ### List of fields @@ -137,7 +147,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). -- beta: Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. +- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Supported keys to describe expected values for a field From ca3fc94e5aa0dd915204fc1548ea286449ae4a50 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 5 Nov 2020 10:57:20 -0600 Subject: [PATCH 09/20] add comment --- scripts/schema/finalizer.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/schema/finalizer.py b/scripts/schema/finalizer.py index 68124fc930..d1b4928507 100644 --- a/scripts/schema/finalizer.py +++ b/scripts/schema/finalizer.py @@ -128,6 +128,7 @@ def append_reused_here(reused_schema, reuse_entry, destination_schema): 'full': reuse_entry['full'], 'short': reused_schema['field_details']['short'], } + # Check for beta attribute if 'beta' in reuse_entry: reused_here_entry['beta'] = reuse_entry['beta'] destination_schema['schema_details']['reused_here'].extend([reused_here_entry]) From f4037effe33c8897444fddfc603400edff09ae98 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Thu, 5 Nov 2020 11:04:59 -0600 Subject: [PATCH 10/20] add beta attribute to a reused_here nestings test condition --- scripts/tests/unit/test_schema_finalizer.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/tests/unit/test_schema_finalizer.py b/scripts/tests/unit/test_schema_finalizer.py index 8a193a0454..d45f8029c6 100644 --- a/scripts/tests/unit/test_schema_finalizer.py +++ b/scripts/tests/unit/test_schema_finalizer.py @@ -92,7 +92,7 @@ def schema_user(self): 'order': 2, 'expected': [ {'full': 'server.user', 'at': 'server', 'as': 'user'}, - {'full': 'user.target', 'at': 'user', 'as': 'target'}, + {'full': 'user.target', 'at': 'user', 'as': 'target', 'beta': 'beta'}, {'full': 'user.effective', 'at': 'user', 'as': 'effective'}, ] } @@ -211,7 +211,7 @@ def test_perform_reuse_with_foreign_reuse_and_self_reuse(self): fields['process']['schema_details']['reused_here']) self.assertIn({'full': 'user.effective', 'schema_name': 'user', 'short': 'short desc'}, fields['user']['schema_details']['reused_here']) - self.assertIn({'full': 'user.target', 'schema_name': 'user', 'short': 'short desc'}, + self.assertIn({'full': 'user.target', 'schema_name': 'user', 'short': 'short desc', 'beta': 'beta'}, fields['user']['schema_details']['reused_here']) self.assertIn({'full': 'server.user', 'schema_name': 'user', 'short': 'short desc'}, fields['server']['schema_details']['reused_here']) From 9222b23ab99d90861c4e8c1ff6f7f7f787b9fa22 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 12:07:54 -0600 Subject: [PATCH 11/20] update wording for changelog entry Co-authored-by: Mathieu Martin --- CHANGELOG.next.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.next.md b/CHANGELOG.next.md index 6fa34dc167..a6b982ad00 100644 --- a/CHANGELOG.next.md +++ b/CHANGELOG.next.md @@ -37,7 +37,7 @@ Thanks, you're awesome :-) --> * Added support for `scaled_float`'s mandatory parameter `scaling_factor`. #1042 * Added ability for --oss flag to fall back `constant_keyword` to `keyword`. #1046 * Added support in the generated Go source go for `wildcard`, `version`, and `constant_keyword` data types. #1050 -* Added support for marking fields as beta in the documentation. #1051 +* Added support for marking fields, field sets, or field reuse as beta in the documentation. #1051 * Added support for `constant_keyword`'s optional parameter `value`. #1112 #### Improvements From 92d0151efbce8b12a7d53dfa11e3bb7052f3722b Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 12:08:25 -0600 Subject: [PATCH 12/20] update wording for field reuse usage Co-authored-by: Mathieu Martin --- schemas/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/README.md b/schemas/README.md index 95e0324fd3..3cf76d8b59 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -105,7 +105,7 @@ The above defines all process fields in both places: } ``` -The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the documentation containing the provided description. +The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the field reuses section, marking specific reuse locations as beta. ``` reusable: From 64156ea36af01454a8c612e7fd6cb957aaa2ec32 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 12:09:02 -0600 Subject: [PATCH 13/20] Use sensible default for boilerplate example Co-authored-by: Mathieu Martin --- schemas/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/README.md b/schemas/README.md index 3cf76d8b59..4d686eb693 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -114,7 +114,7 @@ The `beta` marker can optionally be used along with `at` and `as` to include a b - at: user as: target beta: > - Beta description text here. + Reusing these fields in this location is currently considered beta. ``` ### List of fields From fdd4327cbc76bc58b172953c799441842d1c8321 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 12:10:05 -0600 Subject: [PATCH 14/20] Update test case with a more real-world description Co-authored-by: Mathieu Martin --- scripts/tests/unit/test_schema_finalizer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/tests/unit/test_schema_finalizer.py b/scripts/tests/unit/test_schema_finalizer.py index d45f8029c6..360663cba1 100644 --- a/scripts/tests/unit/test_schema_finalizer.py +++ b/scripts/tests/unit/test_schema_finalizer.py @@ -92,7 +92,7 @@ def schema_user(self): 'order': 2, 'expected': [ {'full': 'server.user', 'at': 'server', 'as': 'user'}, - {'full': 'user.target', 'at': 'user', 'as': 'target', 'beta': 'beta'}, + {'full': 'user.target', 'at': 'user', 'as': 'target', 'beta': 'Some beta notice'}, {'full': 'user.effective', 'at': 'user', 'as': 'effective'}, ] } From c6fb1a6f14718b10142df8f3d0b5a622325ed7c8 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 12:25:37 -0600 Subject: [PATCH 15/20] state convention for field set vs field level labeling Co-authored-by: Mathieu Martin --- schemas/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/schemas/README.md b/schemas/README.md index 4d686eb693..f97af59273 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -147,7 +147,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). -- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. +- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Supported keys to describe expected values for a field From 49e6897cdbe083aee76d985148d97c3e9e0add0f Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Mon, 16 Nov 2020 14:54:02 -0600 Subject: [PATCH 16/20] update expected beta field value --- scripts/tests/unit/test_schema_finalizer.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/tests/unit/test_schema_finalizer.py b/scripts/tests/unit/test_schema_finalizer.py index 360663cba1..cea5c01e6d 100644 --- a/scripts/tests/unit/test_schema_finalizer.py +++ b/scripts/tests/unit/test_schema_finalizer.py @@ -211,7 +211,7 @@ def test_perform_reuse_with_foreign_reuse_and_self_reuse(self): fields['process']['schema_details']['reused_here']) self.assertIn({'full': 'user.effective', 'schema_name': 'user', 'short': 'short desc'}, fields['user']['schema_details']['reused_here']) - self.assertIn({'full': 'user.target', 'schema_name': 'user', 'short': 'short desc', 'beta': 'beta'}, + self.assertIn({'full': 'user.target', 'schema_name': 'user', 'short': 'short desc', 'beta': 'Some beta notice'}, fields['user']['schema_details']['reused_here']) self.assertIn({'full': 'server.user', 'schema_name': 'user', 'short': 'short desc'}, fields['server']['schema_details']['reused_here']) From 2d9deebb3b88259468ebac6764b1deb77e40ad19 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 17 Nov 2020 16:53:27 -0600 Subject: [PATCH 17/20] add single line beta description check --- scripts/schema/cleaner.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/scripts/schema/cleaner.py b/scripts/schema/cleaner.py index 185d0abedc..83f2d15933 100644 --- a/scripts/schema/cleaner.py +++ b/scripts/schema/cleaner.py @@ -76,6 +76,8 @@ def schema_mandatory_attributes(schema): def schema_assertions_and_warnings(schema): '''Additional checks on a fleshed out schema''' single_line_short_description(schema, strict=strict_mode) + if 'beta' in schema['field_details']: + single_line_beta_description(schema, strict=strict_mode) def normalize_reuse_notation(schema): @@ -181,6 +183,8 @@ def field_assertions_and_warnings(field): # check short description length if in strict mode single_line_short_description(field, strict=strict_mode) check_example_value(field, strict=strict_mode) + if 'beta' in field['field_details']: + single_line_beta_description(field, strict=strict_mode) if field['field_details']['level'] not in ACCEPTABLE_FIELD_LEVELS: msg = "Invalid level for field '{}'.\nValue: {}\nAcceptable values: {}".format( field['field_details']['name'], field['field_details']['level'], @@ -220,3 +224,13 @@ def check_example_value(field, strict=True): raise ValueError(msg) else: ecs_helpers.strict_warning(msg) + + +def single_line_beta_description(schema_or_field, strict=True): + if "\n" in schema_or_field['field_details']['beta']: + msg = "Beta descriptions must be single line.\n" + msg += f"Offending field or field set: {schema_or_field['field_details']['name']}" + if strict: + raise ValueError(msg) + else: + ecs_helpers.strict_warning(msg) From 4a8c9312dc2572ba31ce07cf685ca48dc66747e6 Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Tue, 17 Nov 2020 16:53:43 -0600 Subject: [PATCH 18/20] adjust strict warning format --- scripts/generators/ecs_helpers.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/generators/ecs_helpers.py b/scripts/generators/ecs_helpers.py index 801319854c..086f4d592d 100644 --- a/scripts/generators/ecs_helpers.py +++ b/scripts/generators/ecs_helpers.py @@ -189,5 +189,5 @@ def strict_warning(msg): :param msg: custom text which will be displayed with wrapped boilerplate for strict warning messages. """ - warn_message = f"{msg}\n\nThis will cause an exception when running in strict mode." - warnings.warn(warn_message) + warn_message = f"{msg}\n\nThis will cause an exception when running in strict mode.\nWarning check:" + warnings.warn(warn_message, stacklevel=3) From 6f77c76a198d04149b8e4ae91982a859f6c237fe Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Wed, 18 Nov 2020 11:17:06 -0600 Subject: [PATCH 19/20] beta should not have newlines --- schemas/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/schemas/README.md b/schemas/README.md index f97af59273..2624dbd9bc 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -33,6 +33,7 @@ Optional field set attributes: - reusable (optional): Used to identify which field sets are expected to be reused in multiple places. See "Field set reuse" for details. - beta: Adds a beta marker for the entire fieldset. The text provided in this attribute is used as content of the beta marker in the documentation. + Beta should not have newlines. ### Field set reuse @@ -106,6 +107,7 @@ The above defines all process fields in both places: ``` The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the field reuses section, marking specific reuse locations as beta. +Beta should not have newlines. ``` reusable: @@ -113,8 +115,7 @@ The `beta` marker can optionally be used along with `at` and `as` to include a b expected: - at: user as: target - beta: > - Reusing these fields in this location is currently considered beta. + beta: Reusing these fields in this location is currently considered beta. ``` ### List of fields @@ -147,7 +148,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). -- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. +- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Beta should not have newlines. Supported keys to describe expected values for a field From 96ffd6e66ac9c4bd760e148913e39f190ee2a64b Mon Sep 17 00:00:00 2001 From: Eric Beahan Date: Wed, 18 Nov 2020 11:25:10 -0600 Subject: [PATCH 20/20] give notice --- schemas/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/schemas/README.md b/schemas/README.md index 2624dbd9bc..2c14737c4a 100644 --- a/schemas/README.md +++ b/schemas/README.md @@ -33,7 +33,7 @@ Optional field set attributes: - reusable (optional): Used to identify which field sets are expected to be reused in multiple places. See "Field set reuse" for details. - beta: Adds a beta marker for the entire fieldset. The text provided in this attribute is used as content of the beta marker in the documentation. - Beta should not have newlines. + Beta notices should not have newlines. ### Field set reuse @@ -107,7 +107,7 @@ The above defines all process fields in both places: ``` The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the field reuses section, marking specific reuse locations as beta. -Beta should not have newlines. +Beta notices should not have newlines. ``` reusable: @@ -148,7 +148,7 @@ Supported keys to describe fields - format: Field format that can be used in a Kibana index template. - normalize: Normalization steps that should be applied at ingestion time. Supported values: - array: the content of the field should be an array (even when there's only one value). -- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Beta should not have newlines. +- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Beta notices should not have newlines. Supported keys to describe expected values for a field