envoyproxy/envoy

Fix proper noun capitalization in documentation

Open

#20,238 opened on Mar 7, 2022

View on GitHub
 (17 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
area/docsbeginnerenhancementhelp wantedno stalebot

Repository metrics

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

Description

For documentation (including API):

  • Proper nouns should be correctly capitalized, e.g. Envoy instead of envoy.
  • Acronyms are always capitalized, e.g. HTTP instead of http, CEL instead of cel. No camel case in docs.

CC @phlax

Contributor guide

Research direction
Search for instances of improper capitalization in documentation files and correct them according to the guidelines.
Tech stack
None
Domain
documentation
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.
Under 1 hour
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.
90