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] Updates index patterns docs #81864

Merged
merged 12 commits into from
Nov 3, 2020
Merged

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Oct 27, 2020

Summary

This PR:

  • Updates index patterns to indicate they can point to data streams and index aliases
  • Adds information on editing and configuring data fields
  • Adds information about index patterns and time filters

Preview: https://kibana_81864.docs-preview.app.elstc.co/guide/en/kibana/master/index-patterns.html

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.10.0 v7.11 labels Oct 27, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@gchaps gchaps requested review from KOTungseth and mattkime October 27, 2020 22:38
@timroes timroes added v7.11.0 and removed v7.11 labels Oct 29, 2020
you want to work with.
Once you create an index pattern, you're ready to:
{kib} requires an index pattern to access the {es} data that you want to explore.
An index pattern selects the data to use and allows you to define properties of the fields.
Copy link
Contributor

Choose a reason for hiding this comment

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

At this point, do users know what fields are?

or all indices that contain your data. It can also point to a
{ref}/data-streams.html[data stream] or {ref}/indices-aliases.html[index alias].

In this document, you’ll learn how to:
Copy link
Contributor

Choose a reason for hiding this comment

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

This isn't really a document.

docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

@KOTungseth KOTungseth 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 some comments, questions, and suggestions, but Nice Work on this! Our users are going to be so happy!

+
{kib} is now configured to use your {es} data.

. Select this index pattern when you search and visualize your data.

[float]
[[rollup-index-pattern]]
==== Rollup index pattern
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

Create rollup index patterns

```ts
rollup_logstash,kibana_sample_data_logs
```
For an example, refer to <<rollup-data-tutorial,Create and visualize rolled up data>>.

[float]
[[management-cross-cluster-search]]
==== {ccs-cap} index pattern
Copy link
Contributor

Choose a reason for hiding this comment

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

How about:

Create {ccs-cap} index patterns

docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
docs/management/index-patterns.asciidoc Outdated Show resolved Hide resolved
and <<field-formatters-numeric, numbers>>.

A popularity counter keeps track of the fields you use most often.
The top five most popular fields and their values are displayed in *Discover*.
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
The top five most popular fields and their values are displayed in *Discover*.
The top five most popular fields and their values are displayed in <<discover,*Discover*>>.

docs/management/index-patterns.asciidoc Show resolved Hide resolved
To drill down into the fields and associated data types in an index pattern,
click its name in the *Index patterns* overview page.
For more information, refer to <<managing-fields, Index Patterns and Fields>>.
* Learn about <<scripted-fields,scripted fields>> and how to create data on the fly.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are you adding more items to this list? If not, it should stand on it's own instead of an unordered list.

Copy link
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

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

Manual field refresh won't exist from 7.11 onward, otherwise everything looks great!

image:management/index-patterns/images/edit-field-format.png["Edit field format"]

[float]
==== Refresh the data fields
Copy link
Contributor

Choose a reason for hiding this comment

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

This section is only needed for 7.10 and lower.

@gchaps gchaps merged commit ac33148 into elastic:master Nov 3, 2020
@gchaps gchaps deleted the docs/index-patterns branch November 3, 2020 18:17
gchaps added a commit to gchaps/kibana that referenced this pull request Nov 3, 2020
* [DOCS] Updates index patterns docs

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* [DOCS] Incorporates review comments

* [DOCS] Incorporated edits

Co-authored-by: Kaarina Tungseth <[email protected]>
gchaps added a commit to gchaps/kibana that referenced this pull request Nov 3, 2020
* [DOCS] Updates index patterns docs

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* [DOCS] Incorporates review comments

* [DOCS] Incorporated edits

Co-authored-by: Kaarina Tungseth <[email protected]>
gchaps added a commit that referenced this pull request Nov 3, 2020
* [DOCS] Updates index patterns docs

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* [DOCS] Incorporates review comments

* [DOCS] Incorporated edits

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
gchaps added a commit that referenced this pull request Nov 3, 2020
* [DOCS] Updates index patterns docs

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* Update docs/management/index-patterns.asciidoc

Co-authored-by: Kaarina Tungseth <[email protected]>

* [DOCS] Incorporates review comments

* [DOCS] Incorporated edits

Co-authored-by: Kaarina Tungseth <[email protected]>

Co-authored-by: Kaarina Tungseth <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.10.0 v7.11.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants