chore(dev): Detail the format of DEPRECATIONS.md file #19016
+13
−1
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,9 +1,21 @@ | ||||||
| See [DEPRECATION.md](docs/DEPRECATION.md#process) for the process for updating this file. | ||||||
|
|
||||||
| The format for each entry should be: `<version> <identifier> <description>`. | ||||||
|
|
||||||
| - `<version>` should be the version of Vector in which to take the action (deprecate, migrate, or | ||||||
| remove) | ||||||
| - `<identifier>` should be a unique identifier that can also be used in the code to easily find the | ||||||
| places to modify | ||||||
| - `<description>` should be a longer form description of the change to be made | ||||||
|
|
||||||
| For example: | ||||||
|
|
||||||
| - legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed | ||||||
|
Contributor
There was a problem hiding this comment. The version and identifier should be swapped right?
Suggested change
|
||||||
|
|
||||||
| ## To be deprecated | ||||||
|
|
||||||
| ## To be migrated | ||||||
|
|
||||||
| ## To be removed | ||||||
|
|
||||||
| - datadog_v1_metrics v0.35.0 Support for `v1` series endpoint in the `datadog_metrics` sink should be removed. | ||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It might be nice to add an example
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, added.