-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
docs/examples: Shift rst files into example folders #34429
Conversation
/docs |
Docs for this Pull Request will be rendered here: https://storage.googleapis.com/envoy-pr/34429/docs/index.html The docs are (re-)rendered each time the CI |
e72f0dc
to
7bf445c
Compare
/retest |
0aac24c
to
b685f7a
Compare
Signed-off-by: Ryan Northey <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
outs = ["examples_docs.tar.gz"], | ||
cmd = """ | ||
TEMP=$$(mktemp -d) | ||
for location in $(locations :docs_rst); do |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMHO having the list of toctree explicit in the index.rst has the added value of debuggability/maintainability of this code (when failures occur), but I don't feel strong about this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its pretty common for people to forget this and have to (re)cycle ci to fix - also this ensures alpha order
Signed-off-by: Ryan Northey <[email protected]> Signed-off-by: phlax <[email protected]>
Signed-off-by: Ryan Northey <[email protected]> Signed-off-by: phlax <[email protected]>
Signed-off-by: Ryan Northey <[email protected]> Signed-off-by: phlax <[email protected]>
Signed-off-by: Ryan Northey <[email protected]> Signed-off-by: phlax <[email protected]>
Step towards #32737
Commit Message:
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]