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

merged 2 commits into from
Sep 20, 2024

Conversation

jillguyonnet
Copy link
Contributor

@jillguyonnet jillguyonnet commented Sep 19, 2024 •
edited
Loading

Relates elastic/kibana#190730

This PR update the Fleet data stream docs to document the new data stream type custom component template feature.

Before:
Screenshot 2024-09-19 at 17 23 45

After:
Screenshot 2024-09-20 at 11 57 02

@jillguyonnet jillguyonnet requested a review from a team as a code owner September 19, 2024 15:20
@jillguyonnet jillguyonnet self-assigned this Sep 19, 2024
@github-actions GitHub Actions
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@mergify Mergify
Copy link
Contributor

mergify bot commented Sep 19, 2024

This pull request does not have a backport label. Could you fix it @jillguyonnet? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-/d./d is the label to automatically backport to the /d./d branch. /d is the digit
    NOTE: backport-skip has been added to this pull request.

@jillguyonnet
Copy link
Contributor Author

jillguyonnet commented Sep 19, 2024 •
edited
Loading

Hi @kilfoyle 👋 I took the liberty of opening this PR for the documentation side of elastic/kibana#190730 as it seemed quite small 🙂
Edit: the preview page is erroring with 404, please let me know if I'm missing something.

@jillguyonnet jillguyonnet changed the title Add new data stream type custom component template to Fleet data strea… Add new data stream type custom component template to Fleet docs Sep 19, 2024
kilfoyle
kilfoyle reviewed Sep 19, 2024
View reviewed changes
docs/en/ingest-management/data-streams.asciidoc Outdated
Comment on lines 111 to 112
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).

kilfoyle
kilfoyle previously approved these changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

Thanks a lot @jillguyonnet! I always really appreciate when people open up docs PRs. It saves me a lot of time. The text is perfect. Just one small formatting suggestion.

@kilfoyle
Copy link
Contributor

kilfoyle commented Sep 19, 2024 •
edited
Loading

P.S., I think the preview page takes a while. It usually shows up shortly after the docs-build-pr CI finishes up.

I added a backport-8.x label as we're using that, temporarily, for the 8.16 docs.

kilfoyle
kilfoyle reviewed Sep 19, 2024
View reviewed changes
docs/en/ingest-management/data-streams.asciidoc Outdated
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`.
. 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`.

@jillguyonnet
Copy link
Contributor Author

Thank you for your review @kilfoyle @karenzone! I put screenshots in the PR description. Can you please re-approve if everything looks OK? 🙏

kilfoyle
kilfoyle approved these changes Sep 20, 2024
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

It's perfect! 🚀
Thanks a lot @jillguyonnet
LGTM

@jillguyonnet jillguyonnet merged commit b50aa87 into elastic:main Sep 20, 2024
3 checks passed
@jillguyonnet jillguyonnet deleted the 190730-update-fleet-datastream-docs branch September 20, 2024 13:28
mergify bot pushed a commit that referenced this pull request Sep 20, 2024
@jillguyonnet @mergify
Add new data stream type custom component template to Fleet docs (#1335)
e3c6007 
Add new datastream type custom component template to Fleet data streams docs

(cherry picked from commit b50aa87)
@mergify mergify bot mentioned this pull request Sep 20, 2024
Merged
kilfoyle added a commit that referenced this pull request Sep 23, 2024
@mergify @jillguyonnet @kilfoyle
Add new data stream type custom component template to Fleet docs (#1335…
0501e94 
…) (#1342)

Add new datastream type custom component template to Fleet data streams docs

(cherry picked from commit b50aa87)

Co-authored-by: Jill Guyonnet <jill.guyonnet@elastic.co>
Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@karenzone karenzone karenzone left review comments

@kilfoyle kilfoyle kilfoyle approved these changes

Assignees

@jillguyonnet jillguyonnet

Labels
backport-8.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jillguyonnet @kilfoyle @karenzone