envoyproxy/envoy

Fix inline literals in the docs

Open

#19,634 opened on Jan 20, 2022

View on GitHubContributor guide
 (7 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/docshelp wantedlintingtech debt

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (PR metrics pending)

Description

description

historically it was the policy to use single backticks for inline-literals in the docs, which has the effect of making them italics.

the correct rst spec for these is to use double-backticks.

i have been cleaning these up in docs i have worked on or in prs i have reviewed but there are still a lot of places that have italicized inline-literals

we can probably break this up into fixing different parts of the site - ie api, docs, etc

ideally, once this is fixed we would want it to stay fixed - see #19633 for further discussion of this

Contributor guide

Research direction
Search for single backtick inline literal patterns (`...`) in documentation files and replace them with double backticks (``...``). Ensure consistency across the codebase.
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.
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.
Clear
Prerequisites
reStructuredText (RST)
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85