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

Time Series Visual Builder Documentation #11411

Merged
merged 4 commits into from
May 2, 2017

Conversation

simianhacker
Copy link
Member

@simianhacker simianhacker commented Apr 25, 2017

This PR adds the documentation for Time Series Visual Builder.

Closes #11215

@simianhacker simianhacker added Feature:TSVB TSVB (Time Series Visual Builder) v5.4.0 v5.5.0 v6.0.0 labels Apr 25, 2017
@simianhacker simianhacker changed the title [WIP] Time Series Visual Builder Documentation Time Series Visual Builder Documentation Apr 25, 2017
@debadair
Copy link
Contributor

I can make a more detailed editorial pass through this, but in general I'd like to see us move toward more user-centric documentation, where the organization is driven more by what the user is trying to accomplish.

I feel like there are two main tasks here that should be addressed separately--specifying the data you want to display, and customizing the appearance of the resulting visualizations. While people really want to be able to do the latter, the meat of this feature is the ability to combine aggs to do the former. People can pretty easily recognize a color picker and intuit how to use it. Building aggregations and specifying the data you want to display is considerably more opaque.

As far as tone & style, we lean toward directly addressing the user and sticking with the present tense. A few examples:

  • "You can switch". vs "The user can switch"
  • "You can define rules to customize the labels and backgrounds." vs "The labels and backgrounds can be fully customizable based on a set of rules."
  • "The series label is used for visualization-specific legends and titles." vs "Each series supports a label which will be used for legends and titles depending on which visualization type is selected."

I'll try to take a stab at what I mean regarding the organization later this evening.

@tbragin tbragin added Feature:Visualizations Generic visualization features (in case no more specific feature label is available) Team:Docs labels Apr 26, 2017
@debadair
Copy link
Contributor

debadair commented Apr 26, 2017

Basically, I'm thinking something along the lines of:

Building Time Series Visualizations

  • Specifying the Metrics You Want to Visualize
  • Charting Time Series Data
  • Visualizing the Latest Value in a Series
  • Embedding Time Series Data in a Markdown Block
  • Customizing the Appearance of Time Series Visualizations
    • Legends and Titles
    • Axes
    • Annotations
    • Colors
    • Gauge Styles
    • Markdown Styles

The appearance customization info could also just go in the sections that focus on the different types of visualizations, but I think there are some advantages to bumping it out to the top level. For one, it highlights that you have a lot of control over what these things look like. Another is that it lets you talk about the appearance of these things at a higher level. That said, there are also arguments for splitting it up by viz type.

I was playing around with this in the attached file, but don't want to fall too far down the rabbit hole...
time-series-visual-builder-ideas.txt

@thomasneirynck
Copy link
Contributor

thomasneirynck commented Apr 27, 2017

when this is merged, we can link it to the main viz-page docs #11426

@simianhacker
Copy link
Member Author

@debadair I think you're suggestions are great but it's a bigger effort then what we are looking to get in for this first release. I think we should add that to a new ticket and shoot for 5.5 for updated documentation.

@tbragin
Copy link
Contributor

tbragin commented Apr 28, 2017

Let's see what we can merge in for 5.4 and file a ticket for the rest for 5.5

@thomasneirynck
Copy link
Contributor

Before merging, can we add a link from the Viz-landing page, under the Time-series section? https://github.com/elastic/kibana/blob/master/docs/visualize.asciidoc

@simianhacker simianhacker merged commit 216386d into elastic:master May 2, 2017
simianhacker added a commit that referenced this pull request May 2, 2017
* Closes #11215 - Documentation for Time Series Visual Builder

* changing from third person to first

* Adding link to TSVB docs
simianhacker added a commit that referenced this pull request May 2, 2017
* Closes #11215 - Documentation for Time Series Visual Builder

* changing from third person to first

* Adding link to TSVB docs
@simianhacker
Copy link
Member Author

Backported to 5.4 via 7dd37e2
Backported to 5.x via 12fd67b

@simianhacker simianhacker deleted the tsvb-docs branch April 17, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:TSVB TSVB (Time Series Visual Builder) Feature:Visualizations Generic visualization features (in case no more specific feature label is available) review Team:Docs v5.4.0 v5.5.0 v6.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants