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

Move backward compatibility docs under Contributors Guide #37654

Merged
merged 3 commits into from
Feb 5, 2022
Merged

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Dec 29, 2021

Description

Closes #37510

The backward compatibility and deprecations documents were under the how to guide, but these docs do not relate to a specific how to and are relevant for contributors to Gutenberg, whereas the How to guides are targeting extenders.

The deprecations document seems to be out of date and probably a target for removal. I don't know enough if it is being used anymore or if the changelog and publishing process has replaced it. The last update to the document was for 11.0 which was 12 releases ago.

How has this been tested?

Confirm links work as expected. Since the slugs for the documents did not change, WP will handle the redirect.

Types of changes

Documentation.

  • Move backward-compatibility and deprecations docs under contributors/code
  • Update table of contents and manifest to new locations
  • Update link to backward-compatibility document in components contributing

@carolinan
Copy link
Contributor

carolinan commented Jan 7, 2022

I agree, it is nice to have a list of deprecations so that you do not have to browse through massive changelogs.
But unless the list can be automated it may be better to remove it, as it can be mistaken for a complete list of deprecations.

Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@mkaz mkaz merged commit 5ad99f5 into trunk Feb 5, 2022
@mkaz mkaz deleted the docs/37510 branch February 5, 2022 00:07
@github-actions github-actions bot added this to the Gutenberg 12.6 milestone Feb 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Move Backward Compatibility to Explanations, combine Meta Boxes
3 participants