envoyproxy / envoyproxy/envoy

In docs, make use of version_added, version_changed, deprecated etc sphinx directives

Open
#15,763 11 comments 0 reactions 0 assignees View on GitHub
area/docs area/protobuf enhancement help wanted
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
428

Description

### description

if we included in the documentation the version information - ie when added, changed, deprecated or removed it would be very helpful for users.

it would also might make it clearer why problems coming from version/configuration mis/matches do/not work

i think we can get most of this information from protos - not sure immediately how we show removed - but that would be v helpful when upgrading

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing documentation’s Sphinx directive usage and the proto metadata that may provide version information. Define how version_added, version_changed, deprecated, and removed cases should be represented, then confirm that the documentation exposes this information consistently for users upgrading across versions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.