From 4480f6ab0ff30eb3c96390c68e91bccf295fd783 Mon Sep 17 00:00:00 2001 From: Jesse Szwedko Date: Wed, 1 Nov 2023 12:07:27 -0700 Subject: [PATCH 1/3] chore(dev): Detail the format of DEPRECATIONS.md file The format of this file was originally described in https://github.com/vectordotdev/vector/issues/14983 Signed-off-by: Jesse Szwedko --- docs/DEPRECATIONS.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/DEPRECATIONS.md b/docs/DEPRECATIONS.md index 83a39131027ab..484975d7d838d 100644 --- a/docs/DEPRECATIONS.md +++ b/docs/DEPRECATIONS.md @@ -1,5 +1,13 @@ See [DEPRECATION.md](docs/DEPRECATION.md#process) for the process for updating this file. +The format for each entry should be: ` `. + +- `` should be the version of Vector in which to take the action (deprecate, migrate, or + remove) +- `` should be a unique identifier that can also be used in the code to easily find the + places to modify +- `` should be a longer form description of the change to be made + ## To be deprecated ## To be migrated From 85e93236c1cdc9930eb2e8fdf2784fbea3f2334e Mon Sep 17 00:00:00 2001 From: Jesse Szwedko Date: Wed, 1 Nov 2023 12:19:53 -0700 Subject: [PATCH 2/3] Add example Signed-off-by: Jesse Szwedko --- docs/DEPRECATIONS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/DEPRECATIONS.md b/docs/DEPRECATIONS.md index 484975d7d838d..282ecf86a062c 100644 --- a/docs/DEPRECATIONS.md +++ b/docs/DEPRECATIONS.md @@ -8,6 +8,10 @@ The format for each entry should be: ` `. places to modify - `` 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 From 75632f97c4687eecaf79f00e0d40b6f74cf62f43 Mon Sep 17 00:00:00 2001 From: Jesse Szwedko Date: Wed, 1 Nov 2023 12:40:52 -0700 Subject: [PATCH 3/3] markdown linting Signed-off-by: Jesse Szwedko --- docs/DEPRECATIONS.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/DEPRECATIONS.md b/docs/DEPRECATIONS.md index 282ecf86a062c..595d3df95a5ee 100644 --- a/docs/DEPRECATIONS.md +++ b/docs/DEPRECATIONS.md @@ -10,7 +10,7 @@ The format for each entry should be: ` `. For example: -* legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed +- legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed ## To be deprecated @@ -18,6 +18,6 @@ For example: ## To be removed -* Support for `v1` series endpoint in the `datadog_metrics` sink should be removed. -* legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed -* armv7_rpm v0.34.0 The armv7 RPM packages should be removed (replaced by armv7hl) +- Support for `v1` series endpoint in the `datadog_metrics` sink should be removed. +- legacy_openssl_provider v0.34.0 OpenSSL legacy provider flag should be removed +- armv7_rpm v0.34.0 The armv7 RPM packages should be removed (replaced by armv7hl)