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

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Feb 2, 2019

This PR adds a "Breaking Changes" page to the Installation and Upgrade Guide (https://www.elastic.co/guide/en/elastic-stack/master/index.html) and lays the groundwork for adding highlighted breaking changes from across the stack to this book.

After we move to an Asciidoctor build for this book, we can use tagged regions to pull in content from breaking change pages across the library (per https://asciidoctor.org/docs/user-manual/#by-tagged-regions). At that time, the build command will need to change as follows (with --resources parameters added for each repo we pull from):

docbldstk --resource=elasticsearch/docs --resource=kibana/docs --asciidoctor

NOTE: The presence of these tagged regions cannot be processed by our current asciidoc builds, thus the following line must be added to the index.asciidoc to preview the tagged regions:

:asciidoctor-builds: true

@lcawl lcawl added v7.1.0 v8.0.0 and removed WIP Work in progress labels Feb 7, 2019
@lcawl lcawl requested a review from debadair February 7, 2019 19:13
@lcawl lcawl merged commit 891702c into elastic:master Feb 11, 2019
@lcawl lcawl deleted the notable-breaking branch February 11, 2019 18:19
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.

1 participant