envoyproxy/envoy

Use tabs for API info on docs pages

Open

#16,329 opened on May 5, 2021

View on GitHub
 (4 comments) (0 reactions) (1 assignee)C++ (5,373 forks)batch import
api/v3area/docsarea/protobufhelp wanted

Repository metrics

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

Description

description

atm there are various appendages to API info - security status, canonical name, config, extension info

we are also going to add canonical uri, examples, formerly known as info, lifecycle status, and richer extension info

atm it uses .. notes, and .. tips and in some places warnings in others - this is making for a bit of an angry fruit salad

i think we need to shift this info into tabs for API files and fields and figure out how best to prioritize

this will also allow extension examples which adds significantly to the complexity here

Contributor guide

Research direction
Investigate the current API documentation structure in the docs folder, identify the use of notes, tips, and warnings, and propose a tab based layout for API info sections.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
GitDocumentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65