docs: add deprecation section#16520
Merged
techdocsmith merged 7 commits intoapache:30.0.0from May 31, 2024
Merged
Conversation
ektravel
reviewed
May 31, 2024
ektravel
reviewed
May 31, 2024
ektravel
reviewed
May 31, 2024
ektravel
reviewed
May 31, 2024
Contributor
ektravel
left a comment
ektravel
left a comment
There was a problem hiding this comment.
Having two consecutive headings with the word "deprecations" can be confusing. Also calling them "upcoming" is misleading since the features are already deprecated. We should consider different headings to clearly differentiate the two sections. For example:
Upcoming removals
Important features, changes, and deprecations
Contributor
|
@317brian I think we should add this section to the Upgrade notes topic, upgrade-notes.md. I don't think we need to repeat it in the Upgrade notes section of the Release notes topic, release-notes.md. |
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Co-authored-by: Katya Macedo <38017980+ektravel@users.noreply.github.com>
Contributor
Author
|
Copy/pasted the section into upgrade-notes too: |
techdocsmith
approved these changes
May 31, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add deprecation section at the top of the release notes.
Once the migration guide for MVD -> array is merged, we can add a link to it.
@ektravel do you think we should add it to the upgrade notes too?