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] Init breaking changes #8301

Merged
merged 3 commits into from
Oct 10, 2016
Merged

Conversation

jbudz
Copy link
Member

@jbudz jbudz commented Sep 15, 2016

This starts a breaking changes section in the kibana docs. Part of #8077. cc @tbragin @epixa

@Bargs
Copy link
Contributor

Bargs commented Sep 15, 2016

I think these should go in 5.x and get backported to 5.0. That seems to be the way elasticsearch does it https://www.elastic.co/guide/en/elasticsearch/reference/5.x/breaking-changes.html

I'd also recommend following the tree structure that ES uses, so everything looks nice and consistent across products, so:

Breaking changes

| Breaking changes in 5.0

| Sub sections, if necessary, but we probably don't need them right now

@Bargs
Copy link
Contributor

Bargs commented Sep 15, 2016

We're gonna have to get better about applying the breaking label to PRs now, 3/4 of those you listed didn't have it :)

@jbudz jbudz force-pushed the docs-breaking-changes branch from 61545cd to b3e1aaa Compare September 15, 2016 19:25
@jbudz jbudz changed the base branch from 5.0 to 5.x September 15, 2016 19:25
@epixa epixa added v5.0.0 and removed v5.0.0-beta1 labels Sep 20, 2016
@@ -0,0 +1,12 @@
[[breaking-changes]]
== Breaking changes
Copy link
Contributor

Choose a reason for hiding this comment

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

The "c" should be capitalized in changes so it matches the other section titles in the table of contents

@epixa
Copy link
Contributor

epixa commented Oct 10, 2016

I think this needs to be rebased as well

@jbudz jbudz force-pushed the docs-breaking-changes branch from e208cbf to 743c132 Compare October 10, 2016 15:27
@epixa
Copy link
Contributor

epixa commented Oct 10, 2016

@jbudz I'm going to point this against master instead. It clearly lists it as breaking changes in 5.0, so there's no reason why that can't go into master.

@epixa epixa changed the base branch from 5.x to master October 10, 2016 15:50
@epixa
Copy link
Contributor

epixa commented Oct 10, 2016

Nevermind, just changing it via github doesn't work. Can you point these changes at master instead?

@epixa epixa changed the base branch from master to 5.x October 10, 2016 15:51
@jbudz jbudz force-pushed the docs-breaking-changes branch from 743c132 to f10a949 Compare October 10, 2016 15:54
@jbudz jbudz changed the base branch from 5.x to master October 10, 2016 15:54
@jbudz
Copy link
Member Author

jbudz commented Oct 10, 2016

@epixa done

@epixa
Copy link
Contributor

epixa commented Oct 10, 2016

LGTM, let's get this in/backported

@jbudz jbudz merged commit a4b01c4 into elastic:master Oct 10, 2016
elastic-jasper added a commit that referenced this pull request Oct 10, 2016
---------

**Commit 1:**
[docs] Init breaking changes

* Original sha: 3e60953
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T17:35:44Z

**Commit 2:**
[docs] Add separate section for 5.0

* Original sha: 9f0101f
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T19:09:36Z

**Commit 3:**
[docs] Capitalize breaking changes title

* Original sha: f10a949
* Authored by Jonathan Budzenski <[email protected]> on 2016-10-10T14:17:01Z
elastic-jasper added a commit that referenced this pull request Oct 10, 2016
---------

**Commit 1:**
[docs] Init breaking changes

* Original sha: 3e60953
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T17:35:44Z

**Commit 2:**
[docs] Add separate section for 5.0

* Original sha: 9f0101f
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T19:09:36Z

**Commit 3:**
[docs] Capitalize breaking changes title

* Original sha: f10a949
* Authored by Jonathan Budzenski <[email protected]> on 2016-10-10T14:17:01Z
epixa added a commit that referenced this pull request Oct 10, 2016
[backport] PR #8301 to 5.x - [docs] Init breaking changes
epixa added a commit that referenced this pull request Oct 10, 2016
[backport] PR #8301 to 5.0 - [docs] Init breaking changes
airow pushed a commit to airow/kibana that referenced this pull request Feb 16, 2017
---------

**Commit 1:**
[docs] Init breaking changes

* Original sha: bc4a7096b972e98479300411ed134b40eb083872 [formerly 3e60953]
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T17:35:44Z

**Commit 2:**
[docs] Add separate section for 5.0

* Original sha: 02e0808655b09fb436490218ee9cce63ae29a841 [formerly 9f0101f]
* Authored by Jonathan Budzenski <[email protected]> on 2016-09-15T19:09:36Z

**Commit 3:**
[docs] Capitalize breaking changes title

* Original sha: e9d72049cccb047293f6bff1f262187dabc718e1 [formerly f10a949]
* Authored by Jonathan Budzenski <[email protected]> on 2016-10-10T14:17:01Z


Former-commit-id: 8189d1b
airow pushed a commit to airow/kibana that referenced this pull request Feb 16, 2017
[backport] PR elastic#8301 to 5.x - [docs] Init breaking changes

Former-commit-id: e5b1121
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.

3 participants