envoyproxy/envoy

Snap docs/configs/image versions

Open

#6,361 opened on Mar 22, 2019

View on GitHub
 (11 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wantedpriority/high

Repository metrics

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

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.)

Contributor guide

Research direction
Investigate templating mechanisms for docs build to snap references and image tags to specific SHAs. Review current Dockerfile and documentation config files to understand where `latest` tags are used.
Tech stack
cppdocker
Domain
documentationdevopsbuild system
Issue type
Chore
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
GitDocker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60