From 8e25304a55a5324968b3f8cf20e68ca84e9fcd10 Mon Sep 17 00:00:00 2001 From: Felipe Cotti Date: Fri, 21 Mar 2025 14:22:30 -0300 Subject: [PATCH 1/3] Introduce an Issue Report template to be used by docsv3. --- .github/ISSUE_TEMPLATE/issue-report.yaml | 42 ++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue-report.yaml diff --git a/.github/ISSUE_TEMPLATE/issue-report.yaml b/.github/ISSUE_TEMPLATE/issue-report.yaml new file mode 100644 index 0000000000..f419da2e95 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/issue-report.yaml @@ -0,0 +1,42 @@ +name: "Issue report" +description: Report documentation issues such as inaccuracies, broken links, typos, or missing information. +title: "[Issue]: " +labels: ["Issue"] +body: + - type: markdown + attributes: + value: | + Hi 👋. Thanks for taking the time to fill out this issue report! + This form will create an issue that Elastic's docs team will triage and prioritize. + You can also open a PR instead. + - type: dropdown + attributes: + label: Type of issue + description: What type of issue are you reporting? + multiple: false + options: + - Not clear + - Missing information + - Could be improved + - I can't find what I'm looking for + - type: input + id: link + attributes: + label: What documentation page is affected + description: Include a link to the page where you're seeing the problem. + validations: + required: true + - type: textarea + id: related + attributes: + label: What happened? + description: Describe the issue you're experiencing. Screenshots are valuable too! + validations: + required: true + - type: textarea + id: moreinfo + attributes: + label: Additional info + description: Anything else we should know? + validations: + required: false \ No newline at end of file From b906389fe154a95e068a2b22c576ba6ea4ab7fd1 Mon Sep 17 00:00:00 2001 From: Felipe Cotti Date: Fri, 21 Mar 2025 16:21:57 -0300 Subject: [PATCH 2/3] Perform adjustments to labeling, template title and issue type options. --- .github/ISSUE_TEMPLATE/issue-report.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-report.yaml b/.github/ISSUE_TEMPLATE/issue-report.yaml index f419da2e95..d846ee7498 100644 --- a/.github/ISSUE_TEMPLATE/issue-report.yaml +++ b/.github/ISSUE_TEMPLATE/issue-report.yaml @@ -1,7 +1,7 @@ -name: "Issue report" +name: "Docs issue" description: Report documentation issues such as inaccuracies, broken links, typos, or missing information. title: "[Issue]: " -labels: ["Issue"] +labels: ["triage"] body: - type: markdown attributes: @@ -19,6 +19,7 @@ body: - Missing information - Could be improved - I can't find what I'm looking for + - Other - type: input id: link attributes: From 91740388fbb7fb26367fe966b89ed46c0d69c3ff Mon Sep 17 00:00:00 2001 From: Brandon Morelli Date: Mon, 24 Mar 2025 08:21:29 -0700 Subject: [PATCH 3/3] Update .github/ISSUE_TEMPLATE/issue-report.yaml --- .github/ISSUE_TEMPLATE/issue-report.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/issue-report.yaml b/.github/ISSUE_TEMPLATE/issue-report.yaml index d846ee7498..c0c0ebb81a 100644 --- a/.github/ISSUE_TEMPLATE/issue-report.yaml +++ b/.github/ISSUE_TEMPLATE/issue-report.yaml @@ -15,11 +15,11 @@ body: description: What type of issue are you reporting? multiple: false options: - - Not clear + - Inaccurate - Missing information - - Could be improved - I can't find what I'm looking for - Other + - Other - type: input id: link attributes: