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] Fix data stream docs #59818

Merged
merged 9 commits into from
Jul 21, 2020
Merged

[DOCS] Fix data stream docs #59818

merged 9 commits into from
Jul 21, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Jul 17, 2020

Updates the data streams documentation based on feedback.

Changes:

  • Removes collapsible sections. Snippets are now visible without additional clicks.
  • Combines the intro and overview pages
  • Replaces several bulleted lists with headings and sections
  • Overhauls the index template section of 'Set up a data stream'

Any additional feedback is welcome.

Previews

@jrodewig jrodewig added >docs General docs changes v8.0.0 :Data Management/Data streams Data streams and their lifecycles v7.10.0 v7.9.1 labels Jul 17, 2020
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team labels Jul 17, 2020
Copy link
Contributor

@jtibshirani jtibshirani left a comment

Choose a reason for hiding this comment

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

I didn't read the text in detail, but I really like the new structure and layout. It nicely addresses the aspects I found unclear earlier.

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

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

I left a few comments/suggestions. It occurs to me that we'll ultimately want to show the UI here, as well. Future fun. :-)

I think that consolidating the overview information helps. I struggled with the same problem with ILM and ended up duplicating some info because the Overview just felt incomplete without it.

docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/data-streams.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/data-streams.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/data-streams.asciidoc Outdated Show resolved Hide resolved
@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Member

@dakrone dakrone left a comment

Choose a reason for hiding this comment

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

This looks good to me, thanks!

As a separate aside, how should we document the now newly built-in templates for logs-*-* and metrics-*-* as it relates to the new indexing strategy? Do we have docs for that already?

@jrodewig
Copy link
Contributor Author

jrodewig commented Jul 21, 2020

As a separate aside, how should we document the now newly built-in templates for logs-*-* and metrics-*-* as it relates to the new indexing strategy? Do we have docs for that already?

AFAIK we don't have docs for them, but we should. I think most of that content belongs with the index template docs. However, we probably want to update these docs to at least mention the priority in case of a naming collision. In any case, that's probably better suited for a separate PR.

I'll coordinate with @debadair to see who will handle that work. Relates to #57629.

@jrodewig jrodewig merged commit 4a45c2d into elastic:master Jul 21, 2020
@jrodewig jrodewig deleted the docs__ds-feedback branch July 21, 2020 19:46
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.1 v7.10.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants