Skip to content

chore(dev): Detail the format of DEPRECATIONS.md file #19016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jszwedko merged 4 commits into from
Nov 2, 2023
Merged

chore(dev): Detail the format of DEPRECATIONS.md file #19016

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4480f6a
chore(dev): Detail the format of DEPRECATIONS.md file
jszwedko Nov 1, 2023
85e9323
Add example
jszwedko Nov 1, 2023
75632f9
markdown linting
jszwedko Nov 1, 2023
f612a73
Merge remote-tracking branch 'origin/master' into jszwedko/add-detail…
jszwedko Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/DEPRECATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: `<version> <identifier> <description>`.

@neuronull neuronull Nov 1, 2023

Copy link
Copy Markdown
Contributor

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

@jszwedko jszwedko Nov 1, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, added.


- `<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

## To be deprecated

## To be migrated
Expand Down