documentation releasing for release-1.17 - #987
Conversation
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 focuses on updating the Karmada documentation to align with the release-1.17. It includes changes to feature gate statuses, introduces new feature flags, and updates the emulated Kube version. These changes ensure that the documentation accurately reflects the current capabilities and configurations of Karmada components. Highlights
Activity
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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates documentation for the release-1.17 branch. While most of the updates to command-line flags and API definitions in the English documentation appear correct, there are significant issues with the Chinese translations (i18n/zh/). Many translated files have been incorrectly overwritten with English content, and a new translated file was added in English. Additionally, there are a few minor inconsistencies and typos in the English documentation that should be addressed.
Note: Security Review has been skipped due to the limited scope of the PR.
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
There was a problem hiding this comment.
When releasing the documentation this time, an error was encountered:
Error: Markdown image with URL `../../../../static/img/resource-interpreter-framework.png` in source file "versioned_docs/version-v1.16/userguide/globalview/customizing-resource-interpreter.md" (66:1) couldn't be resolved to an existing local image file.This issue occurs because files under the docs directory reference images in the static directory using relative paths. When documentation versions are archived, files from the docs directory are moved to the versioned_docs directory, which changes the relative paths and breaks the image links.
Therefore, files under the docs directory should reference images located in docs/resource instead. This way, the relative paths remain consistent and unchanged.
WDYT? @RainbowMango @windsonsea
There was a problem hiding this comment.
I think it is the picture you are talking about.
The doc has been there for a long time and has gone through several releases. Was the link handled manually before?
There was a problem hiding this comment.
There was a problem hiding this comment.
Was the link handled manually before?
Yes, if no action is taken, we will need to modify it manually for every new release going forward.
There was a problem hiding this comment.
It makes sense to me to move the images from static to docs.
|
preview link: https://deploy-preview-987--karmada.netlify.app/docs/ |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango 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 |
What type of PR is this?
/kind documentation
What this PR does / why we need it:
documentation releasing for release-1.17
Which issue(s) this PR fixes:
Part of karmada-io/karmada#7223
Special notes for your reviewer: