Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use tabs for API info on docs pages #16329

Open
phlax opened this issue May 5, 2021 · 4 comments
Open

Use tabs for API info on docs pages #16329

phlax opened this issue May 5, 2021 · 4 comments
Assignees
Labels
api/v3 Major version release @ end of Q3 2019 area/docs area/protobuf help wanted Needs help!

Comments

@phlax
Copy link
Member

phlax commented May 5, 2021

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

@phlax phlax added triage Issue requires triage api/v3 Major version release @ end of Q3 2019 area/docs area/protobuf help wanted Needs help! and removed triage Issue requires triage labels May 5, 2021
@phlax
Copy link
Member Author

phlax commented May 5, 2021

cc @htuch @mattklein123

@phlax
Copy link
Member Author

phlax commented May 5, 2021

related #16328 #15384 #15344 #16303 #16299

@htuch
Copy link
Member

htuch commented May 6, 2021

Yes, but security and other key warnings must still appear clearly at the top; we can't bury these into tabs because they are unsightly. They are callouts for a reason :)

@phlax
Copy link
Member Author

phlax commented May 6, 2021

...warnings must still appear clearly at the top ... we can't bury these

yep. i will defo follow the principle of no buried warnings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api/v3 Major version release @ end of Q3 2019 area/docs area/protobuf help wanted Needs help!
Projects
None yet
Development

No branches or pull requests

2 participants