[DOCS] Adds tagged region for notable breaking changes #10654
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
karenzone
approved these changes
Apr 5, 2019
lcawl
added a commit
to lcawl/logstash
that referenced
this pull request
Apr 8, 2019
lcawl
added a commit
to lcawl/logstash
that referenced
this pull request
Apr 8, 2019
This was referenced Apr 8, 2019
lcawl
added a commit
that referenced
this pull request
Apr 8, 2019
lcawl
added a commit
that referenced
this pull request
Apr 8, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a tagged region in the Logstash Reference > Breaking Changes page (https://www.elastic.co/guide/en/logstash/master/breaking-changes.html), such that content can be re-used in the Installation and Upgrade Guide (https://www.elastic.co/guide/en/elastic-stack/master/elastic-stack-breaking-changes.html).
At least one tagged region must exist to prevent build errors in the Installation and Upgrade Guide, though as is the case now for V8.0.0 it can be an empty tagged region.
At this time, the Installation and Upgrade Guide for version X only lists the breaking changes specific to that version. If this Logstash page will contain information about multiple versions, we either need to (1) ensure that only the items that are specific to the appropriate version are tagged as "notable" in each branch, or (2) make the tagged regions version-specific (e.g. tag::notable-v8-breaking-changes[]). I'm open to whichever implementation is easier for you to maintain.
Related to elastic/stack-docs#271 and elastic/docs#791