You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/10/20 07:18:52 UTC
[GitHub] [dolphinscheduler] EricGao888 opened a new issue, #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
EricGao888 opened a new issue, #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385
### Search before asking
- [X] I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no similar feature requirement.
### Description
Currently our English doc quality is not so good:
- We have tons of tense, formatting, punctuation, etc. errors and inconsistency of letter case usage in docs.
- Some sentences are ambiguous, misleading or hard to understand.
- We need to avoid passive voice in doc writing.
- Markdown docs are badly formatted.
Since @zhongjiajie has already migrated all docs from website repo to main repo, and we have `spotless` to help with the markdown formatting #11384, it's high time that we refactored the docs.
Besides, we need a guideline for DS English docs writing, see: #11161
related: #6535
### Are you willing to submit a PR?
- [X] Yes I am willing to submit a PR!
### Code of Conduct
- [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] github-actions[bot] closed issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] closed issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
URL: https://github.com/apache/dolphinscheduler/issues/11385
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210134097
> We have tons of tense, formatting, punctuation, etc. errors and inconsistency of letter case usage in docs.
I think we better find some way to auto-fix those issues,
> Markdown docs are badly formatted
I am not sure how spotless auto-fix this, but I am sure there are some of the docs can not be auto fix, like we have HTML style IMG format, beside the auto-fix tool, maybe we also need a checker for our markdown doc and other CI which I already mention in #6535
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1229380931
> > I like this feature, like the auto-fix behavior, but I think we should find out all bad case formats too. I think the second is even more important
>
> @zhongjiajie Just for clarification, for `tense, formatting, punctuation, etc. errors and inconsistency of letter case usage`, I will fix them manually, there is no way for fixing those stuff automatically. Only use `spotless` for markdown formatting.
Yeah, Of cause , but other things like a blank line, HTML syntax img, max cols in each line should be auto-fix if it can
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] github-actions[bot] commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1276877951
This issue has been closed because it has not received response for too long time. You could reopen it if you encountered similar problems in the future.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] github-actions[bot] commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210132111
Thank you for your feedback, we have received your issue, Please wait patiently for a reply.
* In order for us to understand your request as soon as possible, please provide detailed information、version or pictures.
* If you haven't received a reply for a long time, you can [join our slack](https://s.apache.org/dolphinscheduler-slack) and send your question to channel `#troubleshooting`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210136968
> We
BTW, `spotless` fixes `markdown` using `Flexmark`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210135827
> > We have tons of tense, formatting, punctuation, etc. errors and inconsistency of letter case usage in docs.
>
> I think we better find some way to auto-fix those issues,
>
> > Markdown docs are badly formatted
>
> I am not sure how spotless auto-fix this, but I am sure there are some of the docs can not be auto fix, like we have HTML style IMG format, beside the auto-fix tool, maybe we also need a checker for our markdown doc and other CI which I already mention in #6535
@zhongjiajie Thanks for the information, I will take a look at the `doc checker` you mentioned above : )
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210139067
I like this feature, like the auto-fix behavior, but I think we should find out all bad case formats too. I think the second is even more important
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] github-actions[bot] commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1269145321
This issue has been automatically marked as stale because it has not had recent activity for 30 days. It will be closed in next 7 days if no further activity occurs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210141657
> I like this feature, like the auto-fix behavior, but I think we should find out all bad case formats too. I think the second is even more important
Agree, it would be better if those embedded stuff in markdown such as `html` code fragments could be fixed or at least get checked.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [dolphinscheduler] EricGao888 commented on issue #11385: [Improvement][Doc] Fix typos, tense, formatting, letter case, etc. errors in docs
Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11385:
URL: https://github.com/apache/dolphinscheduler/issues/11385#issuecomment-1210171503
> I like this feature, like the auto-fix behavior, but I think we should find out all bad case formats too. I think the second is even more important
@zhongjiajie Just for clarification, for `tense, formatting, punctuation, etc. errors and inconsistency of letter case usage`, I will fix them manually, there is no way for fix those stuff automatically. Only use `spotless` for markdown formatting.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@dolphinscheduler.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org