envoyproxy/envoy

Snap docs/configs/image versions

Open

#6 361 ouverte le 22 mars 2019

Voir sur GitHub
 (11 commentaires) (0 réactions) (0 assignés)C++ (5 373 forks)batch import
area/docshelp wantedpriority/high

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

Related to https://github.com/envoyproxy/envoy/pull/6357. We have two different user bases:

  1. People that run master
  2. People that run tagged versions

We need to do a better job of having a consistent state that works for people. I think this will involve setting up some templating so that when we build the docs, we snap to a specific SHA for everything, including the image tags. This will need more thought since some of our references to latest are checked into code (so maybe some of the Docker files also need to be generated.)

Guide contributeur

Direction de recherche
Le problème fait référence à la PR #6357 et discute de la nécessité de figer les docs/configs sur des SHA spécifiques pour les versions master et étiquetées. Actuellement, les références à 'latest' sont intégrées au code, nécessitant un système de templates et potentiellement la génération de fichiers Docker. Pour commencer, examinez le système de build existant dans le dépôt, en particulier les Dockerfiles et les scripts de génération de documentation. Consultez les commentaires associés pour identifier les points problématiques spécifiques. L'objectif est de proposer une solution de templating qui garantisse un état cohérent entre les différentes bases d'utilisateurs.
Stack technique
cppdocker
Domaine
documentationdevopsbuild system
Type d'issue
Maintenance
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
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
GitDocker
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60