envoyproxy/envoy

Use tabs for API info on docs pages

Open

#16 329 ouverte le 5 mai 2021

Voir sur GitHub
 (4 commentaires) (0 réactions) (1 assigné)C++ (5 373 forks)batch import
api/v3area/docsarea/protobufhelp wanted

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez la structure actuelle de la documentation API dans le dossier docs, identifiez l'utilisation des notes, astuces et avertissements, et proposez une mise en page basée sur des onglets pour les sections d'informations API.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
GitDocumentation
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65