Suggest to use online services like Grammarly to make documentation more concise and easier to read #22180
visortelle
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Many Pulsar contributors aren't native English speakers.
Services like Grammarly suggest rephrasing complex things in simple words.
Not all people know about these services. It's probably a good idea to suggest to use them during writing or editing documentation here: https://pulsar.apache.org/contribute/document-intro/
Alternatively, it may be ChatGPT.
I'm sure it would help to improve the documentation, but not sure that recommending a commercial service aligns with the ASF guidelines for sites.
CNCF recommends it here: https://tag-app-delivery.cncf.io/zh/blog/contributing-to-wg-platforms/#step-3---drafting--reviews
Also, I think it makes sense to add a link to https://pulsar.apache.org/contribute/document-intro/ and include a list of basic recommendations to the apache/pulsar-site repository's
PULL_REQUEST_TEMPLATE.md
to increase the chances that the contributor will read them.Beta Was this translation helpful? Give feedback.
All reactions