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

docs/examples: Shift rst files into example folders #34429

Merged
merged 1 commit into from
Jun 5, 2024

Conversation

phlax
Copy link
Member

@phlax phlax commented May 30, 2024

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:]

@phlax phlax marked this pull request as draft May 30, 2024 13:26
@phlax
Copy link
Member Author

phlax commented May 31, 2024

/docs

Copy link

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 envoy-presubmit (precheck docs) job completes.

🐱

Caused by: a #34429 (comment) was created by @phlax.

see: more, trace.

@phlax phlax force-pushed the examples-rst branch 2 times, most recently from e72f0dc to 7bf445c Compare May 31, 2024 09:16
@phlax phlax changed the title [WIP] docs/examples: Shift rst files into example folders docs/examples: Shift rst files into example folders May 31, 2024
@phlax phlax marked this pull request as ready for review May 31, 2024 09:22
@phlax
Copy link
Member Author

phlax commented May 31, 2024

/retest

@phlax phlax force-pushed the examples-rst branch 4 times, most recently from 0aac24c to b685f7a Compare June 3, 2024 11:16
@phlax phlax changed the title docs/examples: Shift rst files into example folders [WIP] docs/examples: Shift rst files into example folders Jun 3, 2024
@phlax phlax marked this pull request as draft June 3, 2024 14:39
@phlax phlax changed the title [WIP] docs/examples: Shift rst files into example folders docs/examples: Shift rst files into example folders Jun 4, 2024
@phlax phlax marked this pull request as ready for review June 4, 2024 10:52
Copy link
Contributor

@adisuissa adisuissa left a 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
Copy link
Contributor

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.

Copy link
Member Author

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

@adisuissa adisuissa self-assigned this Jun 5, 2024
@phlax phlax merged commit f4930b1 into envoyproxy:main Jun 5, 2024
50 checks passed
phlax added a commit to phlax/envoy that referenced this pull request Sep 20, 2024
phlax added a commit to phlax/envoy that referenced this pull request Sep 20, 2024
phlax added a commit that referenced this pull request Sep 20, 2024
phlax added a commit that referenced this pull request Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants