-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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
Conversation
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:
I'll try to take a stab at what I mean regarding the organization later this evening. |
Basically, I'm thinking something along the lines of: Building Time Series Visualizations
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... |
when this is merged, we can link it to the main viz-page docs #11426 |
@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. |
Let's see what we can merge in for 5.4 and file a ticket for the rest for 5.5 |
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 |
* Closes #11215 - Documentation for Time Series Visual Builder * changing from third person to first * Adding link to TSVB docs
* Closes #11215 - Documentation for Time Series Visual Builder * changing from third person to first * Adding link to TSVB docs
Backported to 5.4 via 7dd37e2 |
This PR adds the documentation for Time Series Visual Builder.
Closes #11215