envoyproxy/envoy

docs: cover timeout scaling in timeout FAQ

Open

#14,775 opened on Jan 20, 2021

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

Repository metrics

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

Description

We should cover the new scaled timeout capability in the timeout FAQ: https://www.envoyproxy.io/docs/envoy/latest/faq/configuration/timeouts

We should probably also cover it in the edge best practices guide: https://www.envoyproxy.io/docs/envoy/latest/configuration/best_practices/edge#best-practices-edge

Contributor guide

Research direction
Read the existing timeout FAQ and edge best practices guide, then trace the scaled timeout implementation in the source code to document it.
Tech stack
cpp
Domain
backendnetworking
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80