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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
