envoyproxy/envoy

Show `patched` flag in dependency docs

Open

#25,368 opened on Feb 6, 2023

View on GitHub
 (3 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docsdependenciesenhancementhelp wanted

Repository metrics

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

Description

Many of our (bazel) dependencies have local patches applied

The dependency docs show the commit/version/etc that is compiled into Envoy - but does not indicate whether the dep/source has been patched - probably it would be good to show this

https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/external_deps.html#external-dependencies

not sure how easy it would be to collate the info as the deps are patched independently of the info in repository_locations but i guess we could shift that info to there

Contributor guide

Research direction
Examine the Envoy repository locations file to understand the current dependency structure. Determine how patches are stored and applied. Propose a method to include a patched flag in repository locations and update the documentation generator to display it.
Tech stack
cpp
Domain
documentation
Issue type
Feature
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.
1-3 hours
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.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65