[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

docs(lint): import Chinese copywriting autocorrect linter #6568

Merged
merged 23 commits into from
Mar 24, 2022
Merged

docs(lint): import Chinese copywriting autocorrect linter #6568

merged 23 commits into from
Mar 24, 2022

Conversation

kwanhur
Copy link
Contributor
@kwanhur kwanhur commented Mar 10, 2022 •
edited
Loading

What this PR does / why we need it:

  • add Chinese copywriting lint job
  • autocorrect fix docs/zh/latest/**/*.md
  • fix CHANGELOG.md conflict between markdownlint and autocorrect
  • add tools usage for linting in CONTRIBUTING.md

#6528

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@kwanhur
docs(lint): Chinese copywriting autocorrect linter
5e33d08 
* add Chinese copywriting lint job
* autocorrect fix docs/zh/latest/**/*.md
* fix CHANGELOG.md conflict between markdownlint and autocorrect

Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur kwanhur marked this pull request as ready for review March 12, 2022 10:01
juzhiyuan
juzhiyuan reviewed Mar 15, 2022
View reviewed changes
Copy link
Member
@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

.github/workflows/doc-lint.yml Show resolved Hide resolved
docs/zh/latest/plugins/gzip.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/proxy-control.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/real-ip.md Outdated Show resolved Hide resolved
@kwanhur
chore: merge master and fix conflicts
7498464 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix APISIX-OpenResty nav link
337d314 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix conflicts
4b3ed66 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix admin-api mtls APISIX-OpenResty nav link
b4c1a4d 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix copywriting
3b3cec1 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix broken link
b805b07 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: fix broken link
440b30d 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@juzhiyuan juzhiyuan requested a review from yzeng25 March 17, 2022 02:54
yzeng25
yzeng25 reviewed Mar 17, 2022
View reviewed changes
docs/zh/latest/README.md Outdated Show resolved Hide resolved
docs/zh/latest/README.md Outdated Show resolved Hide resolved
docs/zh/latest/README.md Outdated Show resolved Hide resolved
docs/zh/latest/README.md Outdated Show resolved Hide resolved
docs/zh/latest/admin-api.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/limit-conn.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/response-rewrite.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/response-rewrite.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/traffic-split.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/traffic-split.md Outdated Show resolved Hide resolved
@yzeng25
Copy link
Contributor
yzeng25 commented Mar 17, 2022

@kwanhur impressive!

leslie-tsang
leslie-tsang reviewed Mar 17, 2022
View reviewed changes
docs/zh/latest/stream-proxy.md Outdated Show resolved Hide resolved
docs/zh/latest/stream-proxy.md Outdated Show resolved Hide resolved
docs/zh/latest/plugins/wolf-rbac.md Outdated Show resolved Hide resolved
kwanhur and others added 4 commits March 17, 2022 17:54
@kwanhur
docs: use punctuation in fullwidth form
b4f8690 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur @leslie-tsang
docs: remove full stop at header
df21b4a 
Co-authored-by: leslie <59061168+leslie-tsang@users.noreply.github.com>
@kwanhur
docs: remove question mark at header
14bdfa4 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
Merge branch 'typo-zh-copywriting' of github.com:kwanhur/apisix into …
5608635 
…typo-zh-copywriting
@juzhiyuan
Copy link
Member

Hi @kwanhur, I try to resolve those conflicts, but I don't know which change I should keep. Please resolve them 🙏

@kwanhur
docs: merge master and fix conflicts
6331b70 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
fix(docs): improving zh discovery kubernetes
c3ecf31 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
docs: remove colon in the how-to-build.md step 1-7 headers
56877d6 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
Copy link
Contributor Author
kwanhur commented Mar 21, 2022

Hi @kwanhur, I try to resolve those conflicts, but I don't know which change I should keep. Please resolve them 🙏

Had resolved conflicts. Some ci jobs need to re-run manually, trigger them plz.

@kwanhur
docs: merge and fix conflicts
d32f76e 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
ci(autocorrect): update download link
b1bd2da 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
ci(autocorrect): simplify fetching latest version
bb01339 
Signed-off-by: kwanhur <huang_hua2012@163.com>
@kwanhur
ci(autocorrect): specify version v1.5.6
0ef83b0 
Signed-off-by: kwanhur <huang_hua2012@163.com>
yzeng25
yzeng25 previously approved these changes Mar 23, 2022
View reviewed changes
Copy link
Contributor
@yzeng25 yzeng25 left a comment

Choose a reason for hiding this comment

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

I think we are good to go now.

juzhiyuan
juzhiyuan previously approved these changes Mar 23, 2022
View reviewed changes
Copy link
Member
@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

Bcoz no other feedback, for now, LGTM.

p.s. I would still prefer using a specified commit id rather than the current way but looks good to me. 🙏

@spacewander
Copy link
Member

@kwanhur
Let's solve the merge conflict before we can merge it.

@kwanhur kwanhur dismissed stale reviews from juzhiyuan and yzeng25 via a50e9bf March 24, 2022 06:23
juzhiyuan
juzhiyuan approved these changes Mar 24, 2022
View reviewed changes
Copy link
Member
@juzhiyuan juzhiyuan left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@spacewander spacewander merged commit 96838b9 into apache:master Mar 24, 2022
@kwanhur kwanhur deleted the typo-zh-copywriting branch March 24, 2022 08:23
@liangliang4ward liangliang4ward mentioned this pull request Mar 24, 2022
Merged
5 tasks
Liu-Junlin pushed a commit to Liu-Junlin/apisix that referenced this pull request May 20, 2022
@kwanhur @leslie-tsang
@juzhiyuan @Liu-Junlin
docs(lint): import Chinese copywriting autocorrect linter (apache#6568)
d720cfb 
Co-authored-by: leslie <59061168+leslie-tsang@users.noreply.github.com>
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
@huacnlee
Copy link
Contributor

https://github.com/marketplace/actions/huacnlee-autocorrect

spacewander pushed a commit that referenced this pull request Jun 30, 2022
@kwanhur @leslie-tsang
@juzhiyuan @spacewander
docs(lint): import Chinese copywriting autocorrect linter (#6568)
c8b7237 
Co-authored-by: leslie <59061168+leslie-tsang@users.noreply.github.com>
Co-authored-by: 琚致远 <juzhiyuan@apache.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Yiyiyimu Yiyiyimu Yiyiyimu left review comments

@leslie-tsang leslie-tsang leslie-tsang left review comments

@juzhiyuan juzhiyuan juzhiyuan approved these changes

@spacewander spacewander spacewander approved these changes

@yzeng25 yzeng25 yzeng25 left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@kwanhur @yzeng25 @juzhiyuan @spacewander @huacnlee @Yiyiyimu @leslie-tsang