Skip to content

Conversation

@gchaps
Copy link
Contributor

@gchaps gchaps commented Jun 1, 2018

This PR is for the 6.3 Release Notes.

My editor automatically removed some spaces in the 6.2.4 Release notes and lower so you can ignore those changes.

@gchaps gchaps requested review from epixa and rayafratkina June 1, 2018 22:13
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@gchaps gchaps requested a review from rashmivkulkarni June 4, 2018 15:05
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.

Looks good!

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.

LGTM though I have some notes:

Overall, I have a lot of the same feedback for this PR as I have for #19634, like consistent new lines at 80 chars, not repeating titles, sentence casing. If you do make these sorts of changes in that PR, then I recommend doing them here as well.

Also, while it isn't introduced in this PR, I reiterate a comment I made in the other PR about not including commented out sections in this changelog. They just make this file harder to parse, and things that are commented tended to become neglected/lack review. For example, one of the commented out sections in this changelog is "Breaking Java Changes", which is clearly not even a Kibana thing, but it was probably copied and pasted over and no one noticed it because it was commented out.

Unrelated, in the future we should probably submit release notes and highlights in the same PR because as it stands now, neither of these two PRs builds properly without the other one due to the cross-linking. Kibana CI doesn't build docs right now, but we intend for it to build docs in the future, and this would cause a red build.

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@epixa epixa added the Team:Docs label Jun 7, 2018
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

@gchaps gchaps merged commit a129ad3 into elastic:6.3 Jun 11, 2018
gchaps added a commit that referenced this pull request Jun 12, 2018
* [DOCS] 6.3 Release Notes

* [DOCS] Incorporated review comments

* [DOC] Updated note about regression because it also affects pipeline creation

* [DOCS] Minor updates to release notes
@gchaps gchaps deleted the docs/release-notes/6.3 branch June 14, 2018 16:09
@jsoref
Copy link
Contributor

jsoref commented Jun 17, 2018

@gchaps: Hi, thanks for working on release notes (I used to do that in a past life). I was wondering if I could encourage you to use a spell checker to improve their quality/readability.

I'm asking because the tool I'm using flagged (at least):

diff --git a/docs/CHANGELOG.asciidoc b/docs/CHANGELOG.asciidoc
--- a/docs/CHANGELOG.asciidoc
+++ b/docs/CHANGELOG.asciidoc
@@ -1697,1 +1697,1 @@ Design::
-* [Accessibilty] Make kbn_accessible_click part of autoload/all  {pull}13299[#13299]
+* [Accessibility] Make kbn_accessible_click part of autoload/all  {pull}13299[#13299]
@@ -1938,1 +1938,1 @@ Design::
-* [Accessibilty] Make kbn_accessible_click part of autoload/all  {pull}13299[#13299]
+* [Accessibility] Make kbn_accessible_click part of autoload/all  {pull}13299[#13299]

-- I made the mistake of running my tool on the 6.3 branch, and since I'm moving my commits to master, I'm dropping this delta.

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.

5 participants