[Doc Workflow] add doc issue template and optimize PR template (apach…

…e#11786) * [Doc Workflow] add doc issue template and optimize PR template * Update .github/ISSUE_TEMPLATE/doc_request.md Co-authored-by: Jennifer Huang <[email protected]> Co-authored-by: Jennifer Huang <[email protected]>
lionelcao · Aug 28, 2021 · c178564 · c178564
1 parent a97bae4
commit c178564
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 15 deletions.
diff --git a/.github/ISSUE_TEMPLATE/doc_request.md b/.github/ISSUE_TEMPLATE/doc_request.md
@@ -0,0 +1,26 @@
+---
+name: Doc request
+about: Suggest doc changes for Pulsar
+title: ''
+labels: doc-required
+assignees: ''
+
+---
+
+Please answer the following questions before submitting your doc issue. Thanks!
+
+# What issue do you find in Pulsar docs?
+
+(For example, something missing, inaccurate, incomplete, hard to use/understand/find, etc)
+
+# What is your suggestion?
+
+(For example, add explanations about xx, correct descriptions of xx, delete information about xx, etc)
+
+# Do you have any references?
+
+(For example, website links, etc)?
+
+# Would you like to fix this issue?
+
+(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!)
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -68,25 +68,20 @@ This change added tests and can be verified as follows:
 
 ### Documentation
 
-#### For contributor
+Check the box below and label this PR (if you have committer privilege).
 
-For this PR, do we need to update docs?
+Need to update docs? 
 
-- If yes, please update docs or create a follow-up issue if you need help.
+- [ ] doc-required 
 
-- If no, please explain why.
-
-#### For committer
-
-For this PR, do we need to update docs?
-
-- If yes,
+  (If you need help on updating docs, create a doc issue)
 
-  - if you update docs in this PR, label this PR with the `doc` label.
+- [ ] no-need-doc 
 
-  - if you plan to update docs later, label this PR with the `doc-required` label.
-
-  - if you need help on updating docs, create a follow-up issue with the `doc-required` label.
+  (Please explain why)
+  
+- [ ] doc 
 
-- If no, label this PR with the `no-need-doc` label and explain why.
+  (If this PR contains doc changes)
+