envoyproxy/envoy

Emit docs for API services

Open

#3,091 opened on Apr 16, 2018

View on GitHubContributor guide
 (5 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
api/v3area/docshelp wantedpriority/high

Repository metrics

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

Description

Start with the access log API services.

Migrated from https://github.com/envoyproxy/data-plane-api/issues/351

Contributor guide

Research direction
Examine the access log API protobuf definitions and generate documentation using the existing doc generation tools.
Tech stack
cpp
Domain
apidocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
Basic understanding of Envoy's API design
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80