Skip to content

Conversation

@gchaps
Copy link
Contributor

@gchaps gchaps commented Jun 1, 2018

This PR creates the Release Highlights doc for 6.3.

@elasticmachine
Copy link
Contributor

💔 Build Failed

Here are the highlights of the features that were added in 6.3 and
how the user experience improved.

Refer to them <<release-notes-6.3.0,6.3.0 Release Notes>> for a list bug
Copy link
Contributor

Choose a reason for hiding this comment

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

Quick typo: "them" should be "the"

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

I added one typo comment, but otherwise LGTM. Great work!

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@gchaps gchaps requested a review from rashmivkulkarni June 4, 2018 15:04
Copy link
Contributor

@rayafratkina rayafratkina left a comment

Choose a reason for hiding this comment

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

LGTM

@epixa
Copy link
Contributor

epixa commented Jun 5, 2018

I think this change will need to happen on master and be backported through to 6.3, no? This way it appears in the list of release notes for future versions beyond 6.3: https://www.elastic.co/guide/en/kibana/current/release-notes.html

@lcawl
Copy link
Contributor

lcawl commented Jun 5, 2018

@epixa We didn't put 5.x release note items into 6.x (e.g. https://www.elastic.co/guide/en/kibana/6.0/release-notes.html), so I assumed the same would be true of 6.x and master in this case. i.e. the 6.3.0 highlights would only go into the 6.3 and 6.x branches

At the end of the trial period, your license reverts to a Basic license.
To continue using the Platinum features, you can purchase a
https://www.elastic.co/subscriptions[subscription] and update
you license.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: you -> your

@@ -1,9 +1,140 @@
[[release-highlights-6.3.0]]
== 6.3.0 release highlights
== 6.3.0 Release Highlights
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought we used sentence case for titles?

Here are the highlights of the features that were added in 6.3 and
how the user experience improved.

Refer to the <<release-notes-6.3.0,6.3.0 Release Notes>> for a list bug
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: I'm not sure if the title is necessary here. I think if you just list <<release-notes-6.3.0>>, it'll automatically pull the title from the corresponding doc so they are guaranteed to be consistent.

This is true of pretty much all the <<>> links in this file.

[float]
=== Return to recently viewed content

{kib} now keeps track of your recently viewed
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: It looks like new lines are created arbitrarily throughout this doc, and I'm not sure why that is. I think we usually hard wrap at 80 characters.

@epixa
Copy link
Contributor

epixa commented Jun 5, 2018

@lcawl Ah yes, you're right of course. My comment should instead apply to 6.x -> 6.3 rather than master -> 6.x -> 6.3.

=== License management and {xpack} code

Starting with version 6.3, all of the free {xpack} features, such
as monitoring, tile maps, Grok Debugger, and Search Profiler,
Copy link
Contributor

Choose a reason for hiding this comment

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

nit : we should either capitalize Monitoring , Tile maps just like Grok Debugger and Search Profiler - or make everything start with small letters?

@rashmivkulkarni
Copy link
Contributor

LGTM

@gchaps
Copy link
Contributor Author

gchaps commented Jun 6, 2018

@epixa Thanks for the review. Here's what I did

  • I fixed the line width/wrap, ending white space problems, and typo
  • The Kibana docs currently use title case for titles so I left that as is
  • I left in the titles for the x-ref because often times I wanted different text from the titles
  • When complete, I'll forward port this doc and the RN to 6.x

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

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.

I added a few comments, let me know what you think @gchaps. Looking good!

=== License management and {xpack} code

Starting with version 6.3, all of the free {xpack} features, such as monitoring
and tile maps, ship with the default distribution of {kib}. When you install

Choose a reason for hiding this comment

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

OSS actually has tile maps, it just doesn't have as many out of the box zoom levels. There are other things you can call out though. Basically, anything that is under the Basic column in the subscription page here

I'd maybe focus on things like CSV export, the dedicated API UI and additional dev tools (grok debugger, search profiler)

image::images/management_basic_license.png[]

[float]
=== Autocomplete and simple syntax

Choose a reason for hiding this comment

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

I don't know if we need to explicitly call out simple syntax, I think something like Query Autocomplete would suffice. Alona has been focusing on this, @AlonaNadler what do you think?

Choose a reason for hiding this comment

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

Also, I think if we're going to show a screenshot of anything in these release highlights, it should be this. This is probably the largest feature in the release.


Once enabled, just start typing in the query bar, and you'll get suggestions for
fields, values for keyword fields, and query operators. For information on the
simplified, easier-to-use syntax, see <<kuery-query>>.

Choose a reason for hiding this comment

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

@AlonaNadler are we updating the docs for the changes to kuery/kql in 6.3?

{kib} now keeps track of your recently viewed items so that you can easily get
back to them. Here's how:

* Your last five recently viewed items are listed at the top of the Home page.

Choose a reason for hiding this comment

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

I see Home is capitalized for Home page. I'd say we either use homepage, home page or Kibana Home. I have no preference here.


* The grid height of the dashboard was decreased from 100 pixels to 20 pixels.

* The number of columns in the grid was increased from 12 pixels to 48 pixels.

Choose a reason for hiding this comment

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

I don't believe these are pixels, just number of columns. See https://staging-website.elastic.co/blog/kibana-6-3-0-released

[float]
=== Chained Input Controls

The <<controls, Controls visualization>> now enables you to chain dropdown menus. When

Choose a reason for hiding this comment

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

You can chain the range slider too. Maybe just generically state that we're now allowing for parent / child definition of controls

=== Enhancements to the console

The autocomplete function in the Dev tools console is now expanded to use {kib}
and Basic {xpack} APIs. This ensures that autocomplete covers the same use cases

Choose a reason for hiding this comment

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

Hmm I'm not sure This ensures that autocomplete covers the same use cases as the query bar and other areas of Kibana is. If anything, we're ensuring that the same API's that are available through Elasticsearch natively now support autocomplete in Console. It's almost a feature parity thing.

Copy link
Contributor

@epixa epixa left a comment

Choose a reason for hiding this comment

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

I have nothing to add on top of Alex's latest round of feedback. Thanks for addressing my prior points.

LGTM

@gchaps
Copy link
Contributor Author

gchaps commented Jun 8, 2018

@alexfrancoeur Thanks for the review. I incorporated your comments. Except for chained input controls, which is only available for dropdown menus.

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@lcawl lcawl requested a review from sophiec20 June 8, 2018 21:37
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@AlonaNadler
Copy link

@gchaps I added 2 suggestions, overall looks good :)

Copy link
Contributor

@peteharverson peteharverson left a comment

Choose a reason for hiding this comment

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

One comment on the custom URL section, otherwise the two ML sections LGTM

=== Custom URL improvements

The inclusion of custom URLs in your {ml} jobs enables users to follow links
from the results in the *Anomaly Explorer* to your URL of choice. For example,
Copy link
Contributor

Choose a reason for hiding this comment

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

The custom URL links appear in the anomalies table found in both the Anomaly Explorer and Single Metric Viewer

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@gchaps gchaps merged commit 775fbfa into elastic:6.3 Jun 11, 2018
gchaps added a commit that referenced this pull request Jun 12, 2018
* [DOCS] 6.3.0 release highlights doc

* [DOCS] Fixed typo

* [DOCS] Updated images in highlights doc

* [DOCS] Incorporated review comments

* [DOCS] Updated text on autocomplete as per review comments

* [DOCS] Adds ML items to Kibana 6.3.0 highlights

* [DOCS] Clarifies custom URL highlight

* [DOCS] Improved text for autocomplete
@gchaps gchaps deleted the docs/highlights/6.3 branch June 14, 2018 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants