You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/12/16 10:40:41 UTC
[GitHub] [pulsar] Anonymitaet opened a new pull request #13359: [Doc workflow] change doc request template from markdown to yml
Anonymitaet opened a new pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359
This PR creates custom issue forms by adding a YAML form definition file, which is more user-friendly and easy to maintain.
For more info about issue forms, see [here](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms).
Previous doc issue template:
This PR changes it to:
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] dave2wave commented on pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
dave2wave commented on pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#issuecomment-998156925
I am going to submit a PR since I have a problem with:
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a change in pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on a change in pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#discussion_r772886281
##########
File path: .github/ISSUE_TEMPLATE/doc_request.yml
##########
@@ -0,0 +1,40 @@
+name: Doc request
+description: Suggest doc changes for Pulsar
+title: "[Doc] "
+labels: ["doc-required"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please answer the following questions before submitting a doc issue. Thanks!
+ - type: textarea
+ attributes:
+ label: What issue do you find in Pulsar docs?
+ description: (For example, something missing, inaccurate, incomplete, hard to use/understand/find, etc)
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: What is your suggestion?
+ description: (For example, add explanations about xx, correct descriptions of xx, delete information about xx, etc)
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Do you have any references?
+ description: (For example, website links, etc)?
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Would you like to fix this issue?
+ description: (Welcome to contribute docs! Pulsar grows from a tiny seed to a big tree with every little effort by us! Your contribution is the sunlight, water, and air!)
+ validations:
+ required: true
+ - type: checkboxes
+ attributes:
+ label: Note
+ description: Please make some research on your question before submitting a doc issue. **Free rider is not welcomed**. Thanks!
+ options:
+ - label: I have made some research on my question and I need help on docs.
Review comment:
This is a soft reminder for issue raisers: please do research your issue and show us more context, so that we can understand your issue clearly and offers help quickly.
When triage issues in the community, you will find that some people just ask questions or make requests casually without reading existing docs carefully. They want to get the answers effortlessly and seems we owe them.
The open-source world welcomes anyone who respects others' work. Everyone needs to learn how to [ask the right questions](https://www.goodreads.com/book/show/394398.Asking_the_Right_Questions).
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] dave2wave edited a comment on pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
dave2wave edited a comment on pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#issuecomment-998156925
I am going to submit a PR since I have a problem with the "free rider" statement.
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] DaveDuggins commented on pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
DaveDuggins commented on pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#issuecomment-995816800
The new format is much better! It doesn't look like I have to approve this. If I do and I'm blocking you, let me know.
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#issuecomment-995664228
Hi @D-2-Ed @DaveDuggins can you help review? Thanks
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] michaeljmarshall commented on a change in pull request #13359: [Doc workflow] change doc request template from markdown to yml
Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on a change in pull request #13359:
URL: https://github.com/apache/pulsar/pull/13359#discussion_r772732561
##########
File path: .github/ISSUE_TEMPLATE/doc_request.yml
##########
@@ -0,0 +1,40 @@
+name: Doc request
+description: Suggest doc changes for Pulsar
+title: "[Doc] "
+labels: ["doc-required"]
+body:
+ - type: markdown
+ attributes:
+ value: |
+ Please answer the following questions before submitting a doc issue. Thanks!
+ - type: textarea
+ attributes:
+ label: What issue do you find in Pulsar docs?
+ description: (For example, something missing, inaccurate, incomplete, hard to use/understand/find, etc)
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: What is your suggestion?
+ description: (For example, add explanations about xx, correct descriptions of xx, delete information about xx, etc)
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Do you have any references?
+ description: (For example, website links, etc)?
+ validations:
+ required: true
+ - type: textarea
+ attributes:
+ label: Would you like to fix this issue?
+ description: (Welcome to contribute docs! Pulsar grows from a tiny seed to a big tree with every little effort by us! Your contribution is the sunlight, water, and air!)
+ validations:
+ required: true
+ - type: checkboxes
+ attributes:
+ label: Note
+ description: Please make some research on your question before submitting a doc issue. **Free rider is not welcomed**. Thanks!
+ options:
+ - label: I have made some research on my question and I need help on docs.
Review comment:
What is the purpose of only having one option on a required list of check boxes? Don't we still want people to contribute doc requests even when they haven't been able to fully research the topic?
For example, if someone asks for a certain feature to be documented, and it is already documented, the underlying issue might be that the documentation isn't easily discoverable, which is still valuable to know.
--
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@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org