From 4480f6ab0ff30eb3c96390c68e91bccf295fd783 Mon Sep 17 00:00:00 2001 From: Jesse Szwedko Date: Wed, 1 Nov 2023 12:07:27 -0700 Subject: [PATCH] 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