envoyproxy / envoyproxy/envoy

Use tabs for API info on docs pages

Open
#16,329 4 comments 0 reactions 1 assignee Claimed by @phlax View on GitHub
api/v3 area/docs area/protobuf help wanted
Dominant language
C++
Stars
28.9k
Forks
5.6k
Avg merge
1d 20h
Merged PRs (30d)
437

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

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.