docs: Fix gRPC API generation for online docs #27014
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
qmonnet
added
area/documentation
qmonnet
force-pushed
the
pr/docs-grpc-api-symlink
branch
2 times, most recently
from
bfd7c61
to
5d4a581
Compare
|
Netlify preview still works 🎉 |
|
Edit: No it doesn't, because we pick the Makefile from the repo, not from the image. The CI error was because I missed that we explicitly run |
qmonnet
added
the
dont-merge/preview-only
To generate the gRPC API reference, we copy the "api" repository at the
root of the repository to "Documentation/_api". This step is required
everywhere we need to build the docs:
- Locally, we run it through the "copy-api" target in
Documentation/Makefile, before generating the HTML.
- Same thing for the Netlify preview, where "copy-api" is a dependency
for the "html-netlify" target.
- However, on ReadTheDocs, where we generate and host the online
documentation, we do not perform this step; nor do we use the
Makefile at all.
As a workaround, let's simplify the way we access the API reference.
Instead of copying the docs, just symlink them from the Documentation
directory.
Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
force-pushed
the
pr/docs-grpc-api-symlink
branch
from
248ff65
to
9070f8e
Compare
qmonnet
removed
the
dont-merge/preview-only
christarazi
approved these changes
Jul 24, 2023
zacharysarah
approved these changes
Jul 24, 2023
qmonnet
added
the
ready-to-merge
|
I confirm the issue is fixed on the online doc 🎉 Let's mark this for backports. |
qmonnet
added
needs-backport/1.12
needs-backport/1.13
2 tasks
2 tasks
nbusseneau
added
backport-pending/1.13
6 tasks
nbusseneau
added
backport-pending/1.14
joestringer
added
backport-done/1.14
nbusseneau
added
backport-done/1.12
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to fix the gRPC API, which is missing from the hosted version of the documentation. Let's try to symlink the
apidirectory instead of having an additional step to copy it.I'll mark this PR for backports if it gets merged and if it indeed fixes the API reference on the hosted documentation.