Skip to content

Commit 115691d

Browse files
committed
docs(deprecation policy): align lifecycle sections with fragment-first flow
The "Deprecation" and "Removal" sections still promised that we notify users via the release upgrade guide, but the rewritten Process section treats the deprecation.d fragment (rendered on the release page and the deprecations index) as the canonical user-facing notification. Update both lifecycle sections to match: the fragment / enacted entry is the default; the upgrade guide remains an option for richer treatment when warranted, not a per-deprecation requirement.
1 parent cafe897 commit 115691d

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

docs/DEPRECATION_POLICY.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,9 @@ A configuration option or feature in Vector is marked as deprecated.
3838

3939
When this happens, we will notify by:
4040

41-
- Listing the deprecation in the Deprecations section of the upgrade guide for the release the deprecation was
42-
introduced in. This will include instructions on how to transition if applicable.
41+
- Adding a [`deprecation.d/`](../deprecation.d/) fragment that lists the deprecation on the release page and on the
42+
always-current [deprecations index](https://vector.dev/deprecations/), including migration guidance. The release's
43+
upgrade guide may also call out the deprecation when it warrants a richer treatment than the fragment provides.
4344
- Adding a deprecation note to the [documentation site][configuration] alongside the configuration or feature being
4445
deprecated.
4546
- When possible, output a log at the `WARN` level if Vector detects deprecated configuration or features being used
@@ -57,8 +58,10 @@ A deprecated configuration option or feature in Vector is removed.
5758

5859
When this happens, we will notify by:
5960

60-
- Listing the removal in the Breaking Changes section of upgrade guide for that release. This will include directions on
61-
how to transition if applicable.
61+
- Recording the removal as an enacted entry in the deprecations data (via `cargo vdev deprecation enact`), which moves
62+
the entry from the active list to the past-deprecations section on the [deprecations index](https://vector.dev/deprecations/)
63+
and surfaces it on the release page. The release's upgrade guide may also call out the removal under Breaking Changes
64+
when it warrants a richer treatment.
6265

6366
When possible, Vector will error at start-up when a removed configuration option or feature is used.
6467

0 commit comments

Comments
 (0)