Skip to content

[DOCS] Adds breaking changes page with content re-use #197

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

Merged
merged 1 commit into from
Feb 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions docs/en/install-upgrade/breaking.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[[elastic-stack-breaking-changes]]
== Breaking changes

Before you upgrade, you must review the breaking changes for each product you
use and make the necessary changes so your code is compatible with {version}.

** {beats-ref}/breaking-changes.html[Beats {version} breaking changes]
** {apm-server-ref}/breaking-changes.html[APM Server {version} breaking changes]
** {ref}/breaking-changes.html[Elasticsearch {version} breaking changes]
** {hadoop-ref}/breaking-changes.html[Elasticsearch Hadoop {version} breaking changes]
** {kibana-ref}/breaking-changes.html[Kibana {version} breaking changes]
** {logstash-ref}/breaking-changes.html[Logstash {version} breaking changes]

[IMPORTANT]
===============================

* If you're upgrading from 2.n, make sure you check the breaking changes from
2.n to 5.n, as well as from 5.n to 6.n!
* If you are using {ml} {dfeeds} that contain discontinued search or query
domain specific language (DSL), the upgrade will fail. In 5.6.5 and later, the
Upgrade Assistant provides information about which {dfeeds} need to be updated.

===============================


ifdef::asciidoctor-builds[]
include::{es-repo-dir}/reference/migration/migrate_7_0.asciidoc[tag=notable-breaking-changes]

include::{kib-repo-dir}/migration/migrate_7_0.asciidoc[tag=notable-breaking-changes]

endif::asciidoctor-builds[]
10 changes: 6 additions & 4 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
[[elastic-stack]]
= Elastic Stack
= Installation and Upgrade Guide

:es-repo-dir: {docdir}/../../elasticsearch/docs
:kib-repo-dir: {docdir}/../../kibana/docs

include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
include::{docdir}/../../elasticsearch/docs/Versions.asciidoc[]
include::{es-repo-dir}/Versions.asciidoc[]

== Overview

Expand Down Expand Up @@ -31,5 +34,4 @@ include::installing-stack.asciidoc[]

include::upgrading-stack.asciidoc[]



include::en/install-upgrade/breaking.asciidoc[]
23 changes: 2 additions & 21 deletions docs/upgrading-stack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,8 @@ you're using any deprecated features and update your code accordingly.
By default, deprecation log messages are enabled at the `WARN` level.

. Review the breaking changes for each product you use
and make the necessary changes so your code is compatible with {version}:
+
--
** {beats-ref}/breaking-changes.html[Beats {version} breaking changes]
** {apm-server-ref}/breaking-changes.html[APM Server {version} breaking changes]
** {ref}/breaking-changes.html[Elasticsearch {version} breaking changes]
** {hadoop-ref}/breaking-changes.html[Elasticsearch Hadoop {version} breaking changes]
** {kibana-ref}/breaking-changes.html[Kibana {version} breaking changes]
** {logstash-ref}/breaking-changes.html[Logstash {version} breaking changes]

[IMPORTANT]
===============================

* If you're upgrading from 2.n, make sure you check the breaking changes from
2.n to 5.n, as well as from 5.n to 6.n!
* If you are using {ml} {dfeeds} that contain discontinued search or query
domain specific language (DSL), the upgrade will fail. In 5.6.5 and later, the
Upgrade Assistant provides information about which {dfeeds} need to be updated.

===============================
--
and make the necessary changes so your code is compatible with {version}. See
<<elastic-stack-breaking-changes>>.

. {ref}/docs-reindex.html[Reindex] or delete any indices created on 2.n. We recommend
upgrading to the most recent 5.6 and using the {xpack} Reindex Helper to reindex 2.n indices.
Expand Down