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

[Fixes #1562] Add example index pattern to Settings > Indices #1591

Merged
merged 4 commits into from
Oct 10, 2014
Merged

[Fixes #1562] Add example index pattern to Settings > Indices #1591

merged 4 commits into from
Oct 10, 2014

Conversation

kkirsche
Copy link
Contributor

@kkirsche kkirsche commented Oct 8, 2014

Fixes Issue #1562 by providing information to the user using the kbn-info directive. Verbage used is based on Logstash's elasticsearch output (http://logstash.net/docs/1.4.2/outputs/elasticsearch#index) documentation.

Photo of change on desktop:
screen shot 2014-10-08 at 2 36 25 pm

Photo of change on mobile:
screen shot 2014-10-08 at 2 36 32 pm

Kevin Kirsche added 2 commits October 8, 2014 14:29
Provide info based on verbage found in Logstash's elasticsearch output (http://logstash.net/docs/1.4.2/outputs/elasticsearch#index) documentation.
@kkirsche kkirsche changed the title Example index pattern patch [Fixes #1562] Add example index pattern to Settings > Indices Oct 8, 2014
@rashidkpc
Copy link
Contributor

I think I'd rather see this as text under the label, that changes depending on if the user has Use event times to create index names enabled. Putting complex(ish) examples in the tooltip makes it hard to copy and paste the example.

@kkirsche
Copy link
Contributor Author

kkirsche commented Oct 8, 2014

That makes sense. Let me take a look at doing that with a help-block underneath. Thank you for the feedback.

Based on @rashidkpc's feedback — display example / help text underneath the label as a help block allowing the user to more easily utilize the data inside of it.
@kkirsche
Copy link
Contributor Author

kkirsche commented Oct 8, 2014

Made that adjustment @rashidkpc — let me know what your thoughts are.
screen shot 2014-10-08 at 4 24 03 pm
screen shot 2014-10-08 at 4 21 32 pm
screen shot 2014-10-08 at 4 23 22 pm
screen shot 2014-10-08 at 4 23 58 pm
screen shot 2014-10-08 at 4 23 31 pm
screen shot 2014-10-08 at 4 23 27 pm

@w33ble
Copy link
Contributor

w33ble commented Oct 8, 2014

Would it make sense to also move that "docs" link down to that line of text as well? And maybe give the link a little more context? It links to the moment date parser, which always seemed kind of odd to me.

After reading through #1562 - perhaps that index selection needs more comprehensive documentation?

@kkirsche
Copy link
Contributor Author

@w33ble — I think moving the "docs" link to the ng-if for when both "Index contains time-based events" and "Use event times to create index names" are checked as it seems to make the most sense in that context specifically.

When you say more comprehensive documentation do you mean within the UI of that page or somewhere else?

@kkirsche
Copy link
Contributor Author

@w33ble — I see what you mean. What are your thoughts of only showing it contextually when "Index contains time-based events" and "Use event times to create index names" are checked as seen below. I think this better describes what the documentation is for and when it is truly helpful.

When you mention more comprehensive documentation do you mean on the UI page or elsewhere?

screen shot 2014-10-10 at 10 15 17 am

Let me know, looking forward to making any changes necessary.

Moved docs link down to the help block and expanded link tag name to provide clearer information to the user about what it is documentation for.
@spalger
Copy link
Contributor

spalger commented Oct 10, 2014

LGTM

@w33ble
Copy link
Contributor

w33ble commented Oct 10, 2014

In general, I think we could definitely use more information about how to specify the index pattern, but I really like how this turned out with what we have there. Nicely done.

w33ble added a commit that referenced this pull request Oct 10, 2014
[Fixes #1562] Add example index pattern to Settings > Indices
@w33ble w33ble merged commit 46a0815 into elastic:master Oct 10, 2014
@kkirsche kkirsche deleted the exampleIndexPattern-patch branch December 18, 2014 18:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants