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] Moves index pattern doc to Discover #53347

Merged
merged 5 commits into from
Jan 7, 2020

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Dec 17, 2019

Summary

This PR updates the index pattern doc:

--Moves the documentation to the Discover section
--Includes the cross cluster search index pattern doc in the main doc
--Improves the intro

Closes #39543

See this formatted version of the doc.

[skip ci]

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.7.0 v7.6.0 labels Dec 17, 2019
@elasticmachine
Copy link
Contributor

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

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.

Made a few small comments, but otherwise, LGTM.


* Interactively explore your data in <<discover, Discover>>.
* Present your data in charts, tables, gauges, tag clouds, and more in <<visualize, Visualize>>.
* Show off your data in a <<canvas, Canvas>> presentation.
Copy link
Contributor

Choose a reason for hiding this comment

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

presentation > workpad

Once you create an index pattern, you're ready to:

* Interactively explore your data in <<discover, Discover>>.
* Present your data in charts, tables, gauges, tag clouds, and more in <<visualize, Visualize>>.
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:

Interpret your data in charts, tables, and more in Visualize.

Once you’ve created an index pattern, you’re presented a table of all fields
and associated data types in the index.
Once you create an index pattern, manually or with a sample data set,
you might want to look at its fields and associated data types
Copy link
Contributor

Choose a reason for hiding this comment

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

Period after types

Use the field dropdown menu to limit to display to a specific field.
See <<managing-fields, Managing fields>> for more detailed information.
* *Manage the index fields.* Click a column header to sort the table by that column.
Use the field dropdown menu to limit to display to a specific field.
Copy link
Contributor

Choose a reason for hiding this comment

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

to display > the display?

* *Manage the index fields.* Click a column header to sort the table by that column.
Use the field dropdown menu to limit to display to a specific field.
See <<managing-fields, Managing fields>> for more detailed information.
* *Manage the index fields.* Click a column header to sort the table by that column.
Copy link
Contributor

@nreese nreese Dec 18, 2019

Choose a reason for hiding this comment

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

I think this section should drop text about sorting columns and filtering fields (seems irrelevant since most tables in Kibana allow these types of interactions). Instead, maybe add text about why a user would want to manage fields, such as adding formatters to format values and creating scripted fields.

Copy link
Member

Choose a reason for hiding this comment

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

++ Agree. I think the "why" is more important than the "how" in this section.

* *Manage the index fields.* Click a column header to sort the table by that column.
Use the field dropdown menu to limit to display to a specific field.
See <<managing-fields, Managing fields>> for more detailed information.
* *Manage the index fields.* Click a column header to sort the table by that column.
Copy link
Member

Choose a reason for hiding this comment

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

++ Agree. I think the "why" is more important than the "how" in this section.

* [[reload-fields]]*Reload the index fields list.* You can reload the index fields list to
pick up any newly-added fields. Doing so also resets Kibana’s popularity counters
for the fields. The popularity counters keep track of the fields
* [[reload-fields]]*Reload the index fields list.* You can reload the index fields list to
Copy link
Member

Choose a reason for hiding this comment

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

In the UI I believe we say "refresh" when you hover over the icon, instead of "reload."

Not sure if using the same terminology in the docs matters, but thought I'd point that out.

Comment on lines 118 to 119
for the fields. The popularity counters keep track of the fields
you’ve used most often in {kib} and are used to sort fields in lists.
Copy link
Member

Choose a reason for hiding this comment

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

"keep track of fields you've used most often" makes this sound like it has a broader scope than it has in reality. Technically today -- as far as I'm aware -- the popularity is only incremented when someone selects columns/fields in Discover, and is also only used for sorting fields in lists in Discover. (Unless of course they manually edit the popularity count in the index patterns field UI).

It's probably okay to keep it this way, but just wanted to clarify this for the sake of accuracy in case you feel it is worth changing.

Copy link
Contributor

@nreese nreese left a comment

Choose a reason for hiding this comment

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

lgtm

@gchaps
Copy link
Contributor Author

gchaps commented Jan 7, 2020

@elasticmachine merge upstream

@gchaps gchaps merged commit 0576327 into elastic:master Jan 7, 2020
gmmorris added a commit to gmmorris/kibana that referenced this pull request Jan 8, 2020
* master: (55 commits)
  [ui/public/utils] Copy rarely used items to where they are consumed (elastic#53819)
  set AppArch team as an owner of the search endpoints (elastic#54131)
  Don't expose Elasticsearch client as Observable (elastic#53824)
  [SIEM] Cleanup unnecessary use of enzyme-to-json (elastic#53980)
  fix ui exports doc (elastic#54138)
  change markdown element title (elastic#54194)
  [Logs UI] Refactor log position to hooks (elastic#53540)
  [SIEM] Implement NP Plugin Setup (elastic#54030)
  [DOCS] Updates ML links (elastic#53613)
  sort renovate packages in config
  Spaces - fix flakey api tests (elastic#54154)
  Remove dependency that was causing effect to re-execute infinitely. (elastic#54160)
  [dev/run] expose unexpected flags as more than just names (elastic#54080)
  [DOCS] Moves index pattern doc to Discover (elastic#53347)
  [SIEM] Cleanup React imports (elastic#53981)
  Update eslint related packages (elastic#54107)
  [Uptime] Added date range filter into expanded list query (elastic#52609)
  [SIEM] Add react/display-name eslint rule (elastic#53107)
  [SIEM] Enable eslint prefer-template rule (elastic#53983)
  Elasticsearch snapshots automation (elastic#53706)
  ...
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.6.0 v7.7.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Move Index Patterns documentation to top level section before Discover section
6 participants