Skip to content

Commit

Permalink
chore(dev): Detail the format of DEPRECATIONS.md file (#19016)
Browse files Browse the repository at this point in the history
* chore(dev): Detail the format of DEPRECATIONS.md file

The format of this file was originally described in #14983

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* Add example

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

* markdown linting

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>

---------

Signed-off-by: Jesse Szwedko <jesse.szwedko@datadoghq.com>
  • Loading branch information
jszwedko authored Nov 2, 2023
1 parent df4921b commit 223dd7b
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/DEPRECATIONS.md
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

## 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.
- datadog_v1_metrics v0.35.0 Support for `v1` series endpoint in the `datadog_metrics` sink should be removed.

0 comments on commit 223dd7b

Please sign in to comment.