[Plugin Hub] Display deprecated fields #7376
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
fabianrbz
added
the
review:general
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
For shorthand fields, this makes sense. But looks like they're now listing the field mapping info directly in that deprecation notice. Maybe we should rephrase this? Something like: "If the deprecation notice for a parameter doesn't include new field mapping info, see the changelog." |
fabianrbz
changed the title
fabianrbz
force-pushed
the
render-deprecation-notice-on-plugin-fields
branch
3 times, most recently
from
d936762
to
4b463b6
Compare
As of version 3.7.x, fields in the plugin schema have been flagged with a `deprecation` key, containing information about the deprecation. This commit adds the fields marked as deprecated to the list of `Deprecated Parameters` on the Configuration Reference page. It also renders a deprecation notice, with the information provided in the field. Note: Fields marked as deprecated are not rendered in the main body of the schema, just in the `Deprecated Parameters` section.
And add a `Deprecation notice` to shorthand fields if they don't have one.
fabianrbz
force-pushed
the
render-deprecation-notice-on-plugin-fields
branch
from
4b463b6
to
ee56773
Compare
lena-larionova
approved these changes
May 22, 2024
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
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.
Description
As of version 3.7.x, fields in the plugin schema have been flagged with a
deprecationkey, containing information about the deprecation.deprecation noticeon deprecated fieldsDeprecated Parametersnoticedeprecation noticetoshorthand_fieldsif they don't have one.Testing instructions
datadog - fields marked as deprecated
session - shorthand fields only (these weren't marked as deprecated)
forward-proxy - shorthand fields were marked as deprecated
Checklist