Skip to content
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

Jump to bottom

Add new data stream type custom component template to Fleet docs #1335

Merged
merged 2 commits into from
Sep 20, 2024
Merged

Add new data stream type custom component template to Fleet docs #1335

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5ce4a2
Add new datastream type custom component template to Fleet data strea…
jillguyonnet Sep 19, 2024
37aa19b
Formatting
jillguyonnet Sep 20, 2024
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
6 changes: 5 additions & 1 deletion docs/en/ingest-management/data-streams.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,11 @@ These templates are loaded when the integration is installed, and are used to co
WARNING: Custom index mappings may conflict with the mappings defined by the integration
and may break the integration in {kib}. Do not change or customize any default mappings.

When you install an integration, {fleet} creates a default `@custom` component template for each data stream. The Custom component templates are named following the pattern: `<name_of_data_stream>@custom`.
When you install an integration, {fleet} creates two default `@custom` component templates:
. A `@custom` component template allowing customization across all documents of a given data stream type, named following the pattern: `<data_stream_type>@custom`.
Copy link
Contributor

@kilfoyle kilfoyle Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you install an integration, {fleet} creates two default `@custom` component templates:
. A `@custom` component template allowing customization across all documents of a given data stream type, named following the pattern: `<data_stream_type>@custom`.
When you install an integration, {fleet} creates two default `@custom` component templates:
* A `@custom` component template allowing customization across all documents of a given data stream type, named following the pattern: `<data_stream_type>@custom`.

We just need a line break after the line with the colon for the list to render properly. Here's how it'll look:

Screenshot 2024-09-19 at 12 29 24 PM

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider an unordered list here? Numbering list items implies procedural steps or a sequence.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @karenzone. I've made that change in the suggestion (and added a second one below).

. A `@custom` component template for each data stream, named following the pattern: `<name_of_data_stream>@custom`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. A `@custom` component template for each data stream, named following the pattern: `<name_of_data_stream>@custom`.
* A `@custom` component template for each data stream, named following the pattern: `<name_of_data_stream>@custom`.


The `@custom` component template specific to a datastream has higher precedence over the data stream type `@custom` component template.

You can edit a `@custom` component template to customize your {es} indices:

Expand Down