Skip to content

[1.x] Adjustments to the field set "usage" docs (#1345) #1353

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 13, 2021
Merged

[1.x] Adjustments to the field set "usage" docs (#1345) #1353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.next.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Thanks, you're awesome :-) -->

* Updated descriptions to use Elastic Security #1305
* Host metrics fields from RFC 0005 are now GA. #1319
* Adjustments to the field set "usage" docs #1345

### Tooling and Artifact Changes

Expand Down
9 changes: 5 additions & 4 deletions docs/field-details.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7809,10 +7809,6 @@ The user fields describe information about the user that is relevant to the even

Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.

Find additional usage and examples in the user fields <<ecs-user-usage,usage>> section.



[discrete]
==== User Field Details

Expand Down Expand Up @@ -8004,6 +8000,11 @@ Note also that the `user` fields may be used directly at the root of the events.



[discrete]
==== User Field Usage

For usage and examples of the user fields please see the <<ecs-user-usage,usage>> section.

include::usage/user.asciidoc[]

[[ecs-user_agent]]
Expand Down
12 changes: 6 additions & 6 deletions scripts/templates/field_details.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@

{{ fieldset['description']|replace("\n", "\n\n") }}

{%- if usage_doc %}

Find additional usage and examples in the {{ fieldset['name'] }} fields <<ecs-{{ fieldset['name']|replace("_", "-") }}-usage,usage>> section.

{% endif %}

{# Fieldset label beta header -#}
{% if fieldset['beta'] -%}

Expand Down Expand Up @@ -147,6 +141,12 @@ Note also that the `{{ fieldset['name'] }}` fields are not expected to be used d
{%- endif -%}{# if 'nestings' or 'reusable' in fieldset #}
{%- if usage_doc %}

{# Field Usage Table Header -#}
[discrete]
==== {{ fieldset['title'] }} Field Usage

For usage and examples of the {{ fieldset['name'] }} fields please see the <<ecs-{{ fieldset['name']|replace("_", "-") }}-usage,usage>> section.

include::usage/{{ fieldset['name'] }}.asciidoc[]

{% endif %}