envoyproxy/envoy

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

Open

#15,763 opened on Mar 30, 2021

View on GitHub
 (11 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsarea/protobufenhancementhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

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

Research direction
Familiarize yourself with the project's documentation structure and Sphinx. Look at the proto files to identify version added, version changed, deprecated, and removed fields. Then add the appropriate directives to the documentation files.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
SphinxGitprotobuf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75