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

Add Sphinx tab renderer to documentation #13213

Closed
phlax opened this issue Sep 22, 2020 · 4 comments · Fixed by #13239
Closed

Add Sphinx tab renderer to documentation #13213

phlax opened this issue Sep 22, 2020 · 4 comments · Fixed by #13239
Labels
area/docs enhancement Feature requests. Not bugs or questions. help wanted Needs help!

Comments

@phlax
Copy link
Member

phlax commented Sep 22, 2020

Description

Where docs diverge - eg:

  • instructions for different platforms
  • providing configs in different formats
  • code snippets for different languages

...it would be really useful to have tab rendering

refs

@phlax phlax added enhancement Feature requests. Not bugs or questions. triage Issue requires triage labels Sep 22, 2020
@yanavlasov yanavlasov added help wanted Needs help! and removed triage Issue requires triage labels Sep 22, 2020
@davinci26
Copy link
Member

@phlax do you have any place in mind in the docs that we could use it today?

I can add it as an example usage in my PR.

@phlax
Copy link
Member Author

phlax commented Sep 23, 2020

i had a look through the docs - there are places where we could use this, but i dont see any where we could use it without changing quite a bit of docs.

One example would be the clone instructions in the sandbox examples - this could be split between ssh/https - but im also wondering if we should put the examples intro docker instructions to an rst include - so its probs out of scope of this ticket. (edit: see comment below #13213 (comment))

i also have another ticket im looking at #9662 - where i think it would be very helpful to have this in place

@phlax
Copy link
Member Author

phlax commented Sep 23, 2020

ref (regarding building docs): #13229

@davinci26 ^^

@phlax
Copy link
Member Author

phlax commented Sep 23, 2020

i dont see any where we could use it without changing quite a bit of docs... so its probs out of scope of this ticket.

@davinci26 i added #13230 which once landed will make it easy to update this example, ie

split https://github.com/envoyproxy/envoy/pull/13230/files#diff-ba8b9695d4b21caa10303d3c9be7aa9dR9 between ssh/https

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs enhancement Feature requests. Not bugs or questions. help wanted Needs help!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants