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.

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

[DOCS] Reformat data stream tutorial docs #57883

Merged
merged 13 commits into from
Jun 10, 2020
Merged

[DOCS] Reformat data stream tutorial docs #57883

merged 13 commits into from
Jun 10, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Jun 9, 2020

Creates new 'Set up a data stream' and 'Use a data stream' tutorial pages, based on
existing content in 'Data streams'.

Also adds tutorials for:

  • Configuring an ILM policy for a data stream
  • Indexing documents to a data stream
  • Searching a data stream
  • Manually rolling over a data stream

I plan to add additional tutorials to these pages (e.g., update the mappings/settings for a data stream's template), but I'm limiting the initial scope to make review easier.

I also plan to revisit the intro and overview content, but that's outside the scope of this PR.

Creates a new page for a 'Set up a data stream' tutorial, based on
existing content in 'Data streams'.

Also adds tutorials for:

* Configuring an ILM policy for a data stream
* Indexing documents to a data stream
* Searching a data stream
* Manually rolling over a data stream
@jrodewig jrodewig added >docs General docs changes v8.0.0 :Data Management/Data streams Data streams and their lifecycles v7.9.0 labels Jun 9, 2020
@jrodewig jrodewig requested review from martijnvg and danhermann June 9, 2020 15:42
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Jun 9, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (:Core/Features/Data streams)

@elasticmachine elasticmachine added the Team:Data Management Meta label for data/management team label Jun 9, 2020
@jrodewig jrodewig changed the title [DOCS] Reformat data stream setup tutorial docs [DOCS] Reformat data stream tutorial docs Jun 9, 2020
Copy link
Member

@martijnvg martijnvg left a comment

Choose a reason for hiding this comment

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

Thanks for improving the docs and adding ilm to tutorial!
LGTM

@jrodewig jrodewig mentioned this pull request Jun 10, 2020
76 tasks
Copy link
Contributor

@danhermann danhermann left a comment

Choose a reason for hiding this comment

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

Looks great to me. I left one minor comment below for your consideration.

Comment on lines 25 to 27
* Data streams are designed to be append-only. While you can index new documents
directly to a data stream, you cannot use a data stream to directly update or
delete individual documents.
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should mention that documents can be updated or deleted from the individual backing indices on a data stream so that this isn't taken as an absolute prohibition on updates or deletes? I think it's definitely right to point out that workflows with significant update/delete operations are not a good match for data streams, though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a good point. I added a related sentence with 06c2998. Thanks @danhermann.

@jrodewig jrodewig merged commit b1e28d9 into elastic:master Jun 10, 2020
@jrodewig jrodewig deleted the docs__reorg-data-stream-docs branch June 10, 2020 17:40
jrodewig added a commit that referenced this pull request Jun 10, 2020
Creates a new page for a 'Set up a data stream' tutorial, based on
existing content in 'Data streams'.

Also adds tutorials for:

* Configuring an ILM policy for a data stream
* Indexing documents to a data stream
* Searching a data stream
* Manually rolling over a data stream
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Data streams Data streams and their lifecycles >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants