Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add textlint for document #1715

Merged
merged 23 commits into from
Jul 1, 2022
Merged

Add textlint for document #1715

merged 23 commits into from
Jul 1, 2022

Conversation

hlts2
Copy link
Collaborator

@hlts2 hlts2 commented Jun 30, 2022

Description:

WHAT

As titled

WHY

We should proofread our document before publishing.

Related Issue:

How Has This Been Tested?:

Environment:

  • Go Version: 1.18.3
  • Docker Version: 20.10.8
  • Kubernetes Version: 1.22.0
  • NGT Version: 1.14.6

Types of changes:

  • Bug fix [type/bug]
  • New feature [type/feature]
  • Add tests [type/test]
  • Security related changes [type/security]
  • Add documents [type/documentation]
  • Refactoring [type/refactoring]
  • Update dependencies [type/dependency]
  • Update benchmarks and performances [type/bench]
  • Update CI [type/ci]

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Checklist:

  • I have read the CONTRIBUTING document.
  • I have checked open Pull Requests for the similar feature or fixes?
  • I have added tests and benchmarks to cover my changes.
  • I have ensured all new and existing tests passed.
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly.

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 hlts2 self-assigned this Jun 30, 2022
@vdaas-ci
Copy link
Collaborator

[CHATOPS:HELP] ChatOps commands.

  • 🙆‍♀️ /approve - approve
  • 💌 /changelog - replace the PR body by changelog details
  • 🍱 /format - format codes and add licenses
  • /gen-test - generate test codes
  • 🏷️ /label - add labels
  • /rebase - rebase master
  • 🔚 2️⃣ 🔚 /label actions/e2e-deploy - run E2E deploy & integration test

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@github-actions github-actions bot added size/XXL and removed size/M labels Jun 30, 2022
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@github-actions github-actions bot added size/M and removed size/M labels Jun 30, 2022
kpango
kpango previously approved these changes Jun 30, 2022
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@github-actions github-actions bot removed the size/M label Jul 1, 2022
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@github-actions github-actions bot added size/M and removed size/M labels Jul 1, 2022
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@github-actions github-actions bot added size/M and removed size/M labels Jul 1, 2022
@kpango
Copy link
Collaborator

kpango commented Jul 1, 2022

I think it would be better to sort each block in .prh.yaml by keywords to prevent duplicate additions, and for future maintainability, I think it would be better to sort them.

  1. create a comment index for each possible word
  2. sort the comment index
  3. sort the rule definition block corresponding to the comment index

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 hlts2 requested a review from kpango July 1, 2022 03:30
@github-actions github-actions bot added size/M and removed size/M labels Jul 1, 2022
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

It would be better to divide definition block and comment block.
comment block should be located between version and rules

Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 hlts2 requested a review from kpango July 1, 2022 08:08
@github-actions github-actions bot added size/M and removed size/M labels Jul 1, 2022
kpango
kpango previously approved these changes Jul 1, 2022
Copy link
Collaborator

@kpango kpango left a comment

Choose a reason for hiding this comment

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

LGTM

.prh.yaml Outdated Show resolved Hide resolved
Co-authored-by: Kiichiro YUKAWA <kyukawa315@gmail.com>
@hlts2 hlts2 requested a review from vankichi July 1, 2022 08:34
@github-actions github-actions bot added the size/M label Jul 1, 2022
@hlts2 hlts2 requested a review from kpango July 1, 2022 08:34
@github-actions github-actions bot removed the size/M label Jul 1, 2022
@kpango kpango merged commit ea6aaeb into master Jul 1, 2022
@kpango kpango deleted the ci/document/add-text-linter branch July 1, 2022 08:45
@kevindiu kevindiu mentioned this pull request Jul 4, 2022
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.

5 participants