You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by li...@apache.org on 2021/12/20 01:07:46 UTC

[pulsar] branch master updated: [Doc workflow] change doc request template from markdown to yml (#13359)

This is an automated email from the ASF dual-hosted git repository.

liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new bc530c3  [Doc workflow] change doc request template from markdown to yml (#13359)
bc530c3 is described below

commit bc530c33a961a9f5c55f7c3ff9485723146c8286
Author: Anonymitaet <50...@users.noreply.github.com>
AuthorDate: Mon Dec 20 09:06:44 2021 +0800

    [Doc workflow] change doc request template from markdown to yml (#13359)
---
 .github/ISSUE_TEMPLATE/doc_request.md  | 26 ----------------------
 .github/ISSUE_TEMPLATE/doc_request.yml | 40 ++++++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+), 26 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/doc_request.md b/.github/ISSUE_TEMPLATE/doc_request.md
deleted file mode 100644
index 95997d6..0000000
--- a/.github/ISSUE_TEMPLATE/doc_request.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-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!)
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/doc_request.yml b/.github/ISSUE_TEMPLATE/doc_request.yml
new file mode 100644
index 0000000..d06320f
--- /dev/null
+++ b/.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.
+          required: true
\ No newline at end of file