envoyproxy/envoy

Use tabs for API info on docs pages

Open

#16.329 geöffnet am 5. Mai 2021

Auf GitHub ansehen
 (4 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (5.373 Forks)batch import
api/v3area/docsarea/protobufhelp wanted

Repository-Metriken

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

Beschreibung

description

atm there are various appendages to API info - security status, canonical name, config, extension info

we are also going to add canonical uri, examples, formerly known as info, lifecycle status, and richer extension info

atm it uses .. notes, and .. tips and in some places warnings in others - this is making for a bit of an angry fruit salad

i think we need to shift this info into tabs for API files and fields and figure out how best to prioritize

this will also allow extension examples which adds significantly to the complexity here

Contributor Guide

Research-Richtung
Untersuchen Sie die aktuelle API Dokumentationsstruktur im docs Ordner, identifizieren Sie die Verwendung von Notizen, Tipps und Warnungen und schlagen Sie ein tabbasiertes Layout für API Infoabschnitte vor.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
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
GitDocumentation
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65