envoyproxy/envoy

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

Open

#15.763 geöffnet am 30. März 2021

Auf GitHub ansehen
 (11 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docsarea/protobufenhancementhelp wanted

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Machen Sie sich mit der Dokumentationsstruktur des Projekts und Sphinx vertraut. Sehen Sie sich die Proto Dateien an, um die Felder version added, version changed, deprecated und removed zu identifizieren. Fügen Sie dann die entsprechenden Direktiven zu den Dokumentationsdateien hinzu.
Tech Stack
cpp
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
SphinxGitprotobuf
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75