Skip to content

Commit 223dd7b

Browse files
authored
chore(dev): Detail the format of DEPRECATIONS.md file (#19016)
* chore(dev): Detail the format of DEPRECATIONS.md file The format of this file was originally described in #14983 Signed-off-by: Jesse Szwedko <[email protected]> * Add example Signed-off-by: Jesse Szwedko <[email protected]> * markdown linting Signed-off-by: Jesse Szwedko <[email protected]> --------- Signed-off-by: Jesse Szwedko <[email protected]>
1 parent df4921b commit 223dd7b

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/DEPRECATIONS.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
See [DEPRECATION.md](docs/DEPRECATION.md#process) for the process for updating this file.
22

3+
The format for each entry should be: `<version> <identifier> <description>`.
4+
5+
- `<version>` should be the version of Vector in which to take the action (deprecate, migrate, or
6+
remove)
7+
- `<identifier>` should be a unique identifier that can also be used in the code to easily find the
8+
places to modify
9+
- `<description>` should be a longer form description of the change to be made
10+
11+
For example:
12+
13+
- legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed
14+
315
## To be deprecated
416

517
## To be migrated
618

719
## To be removed
820

9-
* datadog_v1_metrics v0.35.0 Support for `v1` series endpoint in the `datadog_metrics` sink should be removed.
21+
- datadog_v1_metrics v0.35.0 Support for `v1` series endpoint in the `datadog_metrics` sink should be removed.

0 commit comments

Comments
 (0)