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: Documentation for 6.6 Explore and Logs panel features #21754

Merged
merged 8 commits into from
Feb 5, 2020

Conversation

ivanahuckova
Copy link
Member

@ivanahuckova ivanahuckova commented Jan 27, 2020

What this PR does / why we need it:
Documentation for new features in Logs Pane and Explore:

  • Wrap lines visualisation options
  • Unique labels visualisation options

@ivanahuckova ivanahuckova added the type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project label Jan 27, 2020
@ivanahuckova ivanahuckova self-assigned this Jan 27, 2020
docs/sources/features/explore/index.md Show resolved Hide resolved
### Timestamp and Local time
#### Time

Shows or hides the time column. This is the timestamp associated with the log line as reported from the datasource.
Copy link
Contributor

Choose a reason for hiding this comment

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

Per the Documentation Style Guide, "data source" is two words.

Copy link
Member Author

Choose a reason for hiding this comment

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

✅ updated


* Timestamp: shows/hides the Timestamp column
* Local time: shows/hides the Local time column
Wrap-lines option for logs, as for some of our users it’s more efficient to see one line per log message. The wrapped-line option is set as a default, unwrapped setting results in horizontal scrolling.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you mean that this option toggles line wrapping? I would say something like

Set this to True if you want the display to use line wrapping. Otherwise, set it to False. (Or however you set this.)

@ivanahuckova
Copy link
Member Author

@oddlittlebird Whenever you have time, can you please review. 🙂

Copy link
Contributor

@oddlittlebird oddlittlebird left a comment

Choose a reason for hiding this comment

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

Just a few minor format suggestions, otherwise this looks good to go.

docs/sources/features/explore/index.md Outdated Show resolved Hide resolved
docs/sources/features/explore/index.md Outdated Show resolved Hide resolved
docs/sources/features/explore/index.md Outdated Show resolved Hide resolved
docs/sources/features/panels/logs.md Outdated Show resolved Hide resolved
docs/sources/features/panels/logs.md Outdated Show resolved Hide resolved
ivanahuckova and others added 5 commits February 5, 2020 21:15
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
@ivanahuckova ivanahuckova merged commit c16040a into master Feb 5, 2020
@ivanahuckova ivanahuckova deleted the ivanah-explore-6-docs branch February 5, 2020 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Flags the technical writing team for documentation support; auto adds to org-wide docs project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants