Skip to content

feature(workflow): added chinese docs grammer checker#1484

Merged
kmesh-bot merged 1 commit intokmesh-net:mainfrom
yashisrani:feature/chinese-doc-grammer-checker
Aug 18, 2025
Merged

feature(workflow): added chinese docs grammer checker#1484
kmesh-bot merged 1 commit intokmesh-net:mainfrom
yashisrani:feature/chinese-doc-grammer-checker

Conversation

@yashisrani
Copy link
Contributor

What type of PR is this?

/kind enhancement
/kind documentation
/kind feature

What this PR does / why we need it:
This PR introduces a new GitHub Actions workflow to automatically check the grammar, spelling, and style of Chinese documentation in the Kmesh project. The workflow uses LanguageTool to analyze .md files in the docs/cn/zh/ directory and provides actionable feedback to contributors.

The goal is to:

  • Improve the quality and professionalism of Chinese documentation
  • Catch common errors (e.g., "降低3倍", "原因是因为") early in the contribution process
  • Provide non-blocking, helpful suggestions to authors
  • Reduce the burden of manual grammar review

Which issue(s) this PR fixes:
Fixes #1412

Special notes for your reviewer:

  • The workflow runs on push and pull_request events to main branch
  • It only checks files under docs/cn/zh/** to focus on Chinese content
  • The workflow uses ::warning annotations instead of ::error to avoid blocking PRs
  • Emojis are used for better readability and visual scanning of logs

Does this PR introduce a user-facing change?:

NONE

Signed-off-by: GitHub Action <action@github.com>
@kmesh-bot kmesh-bot added the kind/enhancement New feature or request label Aug 14, 2025
@gemini-code-assist
Copy link

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

@kmesh-bot
Copy link
Collaborator

@yashisrani: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

Details

In response to this:

What type of PR is this?

/kind enhancement
/kind documentation
/kind feature

What this PR does / why we need it:
This PR introduces a new GitHub Actions workflow to automatically check the grammar, spelling, and style of Chinese documentation in the Kmesh project. The workflow uses LanguageTool to analyze .md files in the docs/cn/zh/ directory and provides actionable feedback to contributors.

The goal is to:

  • Improve the quality and professionalism of Chinese documentation
  • Catch common errors (e.g., "降低3倍", "原因是因为") early in the contribution process
  • Provide non-blocking, helpful suggestions to authors
  • Reduce the burden of manual grammar review

Which issue(s) this PR fixes:
Fixes #1412

Special notes for your reviewer:

  • The workflow runs on push and pull_request events to main branch
  • It only checks files under docs/cn/zh/** to focus on Chinese content
  • The workflow uses ::warning annotations instead of ::error to avoid blocking PRs
  • Emojis are used for better readability and visual scanning of logs

Does this PR introduce a user-facing change?:

NONE

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@codecov
Copy link

codecov bot commented Aug 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 38.40%. Comparing base (89a29e7) to head (2c75f30).
⚠️ Report is 36 commits behind head on main.
see 2 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 05dd8d5...2c75f30. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@hzxuzhonghu hzxuzhonghu left a comment

Choose a reason for hiding this comment

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

/lgtm

@kmesh-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: hzxuzhonghu

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

@kmesh-bot kmesh-bot merged commit aff74c7 into kmesh-net:main Aug 18, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[OSPP 2025] Kmesh website automation capacity building and documentation optimization

4 participants