[Docs] Propose a deprecation policy for the project #17063
Conversation
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
There was a problem hiding this comment.
Pull Request Overview
This PR proposes an official deprecation policy for the project to clearly document the process for deprecating and eventually removing features from vLLM. Key changes include:
- Adding a reference to the deprecation policy in the main documentation index.
- Updating the metrics design document to link to the deprecation policy.
- Introducing a new document outlining the deprecation pipeline, guidelines, and example timeline.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/source/index.md | Added a link to the deprecation policy in the contributing section. |
| docs/source/design/v1/metrics.md | Inserted a reference to the deprecation policy in the metrics documentation. |
| docs/source/contributing/deprecation_policy.md | New document detailing the deprecation process and timeline. |
vLLM has deprecated some features, though we lack a formal policy for how and when we will deprecate features and eventually remove this. This document includes a proposed process for that. Signed-off-by: Russell Bryant <[email protected]>
russellb
force-pushed
the
deprecation-policy
branch
from
3629df5 to
f6b7d20
Compare
vLLM has deprecated some features, though we lack a formal policy for
how and when we will deprecate features and eventually remove them.
This document includes a proposed process for that.
Signed-off-by: Russell Bryant [email protected]