Skip to content

documentation releasing for release-1.17 - #987

Merged
karmada-bot merged 1 commit into
karmada-io:mainfrom
zhzhuang-zju:newrelease
Mar 9, 2026
Merged

karmada-bot merged 1 commit into
karmada-io:mainfrom
zhzhuang-zju:newrelease

Conversation

@zhzhuang-zju

Copy link
Copy Markdown
Contributor

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:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 6, 2026
@karmada-bot karmada-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Mar 6, 2026
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello, 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

  • Documentation Update: This PR updates the documentation for release-1.17, ensuring it reflects the current state of the Karmada components and their features.
  • Feature Gate Status: Several feature gates are updated from ALPHA to BETA status, indicating increased stability and readiness for broader use.
  • New Feature Flags: Introduces new feature flags like 'WorkloadAffinity' and 'ConstrainedImpersonation', providing more control over Karmada's behavior.
  • Kube Version Emulation: Updates the emulated Kube version to 1.35, ensuring compatibility with the latest Kubernetes features.
Activity
  • The PR addresses issue #7223, which involves documentation release for version 1.17.
  • The author, zhzhuang-zju, has marked this PR as a documentation update.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/reference/components/karmada-search.md
Signed-off-by: zhzhuang-zju <m17799853869@163.com>

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

![Resource Interpreter Operations](../../../static/img/resource-interpreter-framework.png)

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?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It makes sense to me to move the images from static to docs.

@zhzhuang-zju

Copy link
Copy Markdown
Contributor Author

@RainbowMango RainbowMango left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Mar 9, 2026
@karmada-bot

Copy link
Copy Markdown
Contributor

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 9, 2026
@karmada-bot
karmada-bot merged commit 1c0cff7 into karmada-io:main Mar 9, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants