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.

Sign up for GitHub

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

Jump to bottom

[docs] Add documentation for the context view #11222

Merged
merged 4 commits into from
Apr 24, 2017
Merged

[docs] Add documentation for the context view #11222

merged 4 commits into from
Apr 24, 2017

Conversation

weltenwort
Copy link
Member

This PR updates the screenshots showing the changed links in the Discover table and adds a page documenting the context view. Documentation for the new settings was already included in the original PR #9198.

fixes #11216

@weltenwort weltenwort self-assigned this Apr 13, 2017
alexfrancoeur
alexfrancoeur approved these changes Apr 19, 2017
View reviewed changes
Copy link

@alexfrancoeur alexfrancoeur left a comment

Choose a reason for hiding this comment

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

Added a few comments inline. They are minor formatting / text modifications. Other than that - LGTM

docs/discover/context.asciidoc Outdated

image::images/Discover-ContextView-SizePicker-Older.png[]

NOTE: The number of documents loaded with each button click can be configured
Copy link

Choose a reason for hiding this comment

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

For this note can we change this to "The default number of documents.."

docs/discover/context.asciidoc Outdated
table entry and then click the *View surrounding documents* link.

image::images/Expanded-Document.png[Expanded Document]

Copy link

Choose a reason for hiding this comment

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

This is a very minor formatting issue, but I've been told that adding {nbsp} and then a new line is a hack that will correctly space between the image and the text. Right now when you build the docs, they are very close together.

docs/discover/context.asciidoc
same set of columns as the Discover view the context was opened from.

image::images/Discover-ContextView.png[Context View]

Copy link

Choose a reason for hiding this comment

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

{nbsp} + new line

docs/discover/context.asciidoc Outdated
desired number into the input box right of the button.

image::images/Discover-ContextView-SizePicker-Newer.png[]

Copy link

Choose a reason for hiding this comment

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

{nbsp} + new line

docs/discover/context.asciidoc Outdated
desired number into the input box right of the button.

image::images/Discover-ContextView-SizePicker-Older.png[]

Copy link

Choose a reason for hiding this comment

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

{nbsp} + new line

@Bargs Bargs self-requested a review April 19, 2017 16:23
@weltenwort weltenwort force-pushed the documentation/context-view-phase1 branch from 5e14b03 to f5ace76 Compare April 20, 2017 09:50
@weltenwort
Copy link
Member Author

weltenwort commented Apr 20, 2017 •
edited
Loading

@alexfrancoeur I changed the spacing and wording as you suggested except for the image preceding the NOTE: , the spacing of which looked fine to me.

@alexfrancoeur
Copy link

@weltenwort great! LGTM

Bargs
Bargs approved these changes Apr 21, 2017
View reviewed changes
Copy link
Contributor

@Bargs Bargs left a comment

Choose a reason for hiding this comment

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

One tiny nitpick, but overall looks great!

docs/discover/context.asciidoc Outdated
You can change the number documents displayed before and after the anchor
document independently.

To increase the number of displayed documents, that are newer than the anchor
Copy link
Contributor

Choose a reason for hiding this comment

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

IANAW but the comma after "documents" seems unnecessary and tripped me up a bit while reading this sentence the first time.

Copy link
Member Author

@weltenwort weltenwort Apr 24, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Good catch! 👍 Happens to me a lot, because it is mandatory in German. 😊

docs/discover/context.asciidoc Outdated
image::images/Discover-ContextView-SizePicker-Newer.png[]
{nbsp}

To increase the number of displayed documents, that are older than the anchor
Copy link
Contributor

Choose a reason for hiding this comment

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

Same for the comma here.

@weltenwort weltenwort merged commit 9317574 into elastic:master Apr 24, 2017
weltenwort added a commit to weltenwort/kibana that referenced this pull request Apr 24, 2017
@weltenwort
[5.x] [docs] Add documentation for the context view
0af0368 
Backports PR elastic#11222

Add documentation for the context view

fixes elastic#11216
@weltenwort weltenwort mentioned this pull request Apr 24, 2017
Merged
weltenwort added a commit that referenced this pull request Apr 24, 2017
@weltenwort
[5.x] [docs] Add documentation for the context view (#11382)
ab42b27 
Backports PR #11222

Add documentation for the context view

fixes #11216
weltenwort added a commit to weltenwort/kibana that referenced this pull request Apr 24, 2017
@weltenwort
[5.4] [docs] Add documentation for the context view
b71d5d3 
Backports PR elastic#11222

Add documentation for the context view

fixes elastic#11216
@weltenwort weltenwort mentioned this pull request Apr 24, 2017
Merged
weltenwort added a commit that referenced this pull request Apr 24, 2017
@weltenwort
[5.4] [docs] Add documentation for the context view (#11384)
f0a2f9a 
Backports PR #11222

Add documentation for the context view

fixes #11216
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Bargs Bargs Bargs approved these changes

@alexfrancoeur alexfrancoeur alexfrancoeur approved these changes

@debadair debadair Awaiting requested review from debadair

@tbragin tbragin Awaiting requested review from tbragin

Assignees

@weltenwort weltenwort

Labels
review Team:Docs v5.4.0 v6.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs for log event context phase 1
3 participants
@weltenwort @alexfrancoeur @Bargs