chore: migrate api document generation to tool to crd-ref-docs#5702
Conversation
- Replace old API doc generation script with crd-ref-docs tool invocation - Update Makefile to download and use crd-ref-docs binary - Set crd-ref-docs tool version and local binary path in Makefile Signed-off-by: TzZtzt <trafalgarz@outlook.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request modernizes the project's API documentation generation process by switching to a more actively maintained and robust tool. This change improves the reliability and future maintainability of the API reference documentation, ensuring that the project's API specifications remain accurate and easily accessible. The migration involves updating build scripts and replacing old tool-specific files with new ones tailored for the chosen tool. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request successfully migrates the API documentation generation from the unmaintained gen-crd-api-reference-docs to crd-ref-docs. The changes are well-contained, including updating the Makefile to use the new tool, adding the new configuration file, and cleaning up the files related to the old tool. I have one suggestion to improve the robustness of the new configuration.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #5702 +/- ##
=======================================
Coverage 61.22% 61.22%
=======================================
Files 444 444
Lines 30557 30557
=======================================
Hits 18710 18710
Misses 10307 10307
Partials 1540 1540 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cheyang The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
Ⅰ. Describe what this PR does
Migrate api document generation tool from gen-crd-api-reference-docs(no longer actively maintained) to crd-ref-docs
Ⅱ. Does this pull request fix one issue?
NONE
Ⅲ. List the added test cases (unit test/integration test) if any, please explain if no tests are needed.
Ⅳ. Describe how to verify it
Ⅴ. Special notes for reviews