diff --git a/.github/ISSUE_TEMPLATE/0_typos-and-grammar.yml b/.github/ISSUE_TEMPLATE/0_typos-and-grammar.yml new file mode 100644 index 0000000000..2a7ab587c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/0_typos-and-grammar.yml @@ -0,0 +1,30 @@ +name: Typos and Grammar +description: Report typos, spelling mistakes, or grammar issues. +labels: ["copy-editing"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: input + id: issue-url + attributes: + label: Page URL + description: The page where the issue occurs + placeholder: "For example, https://docs.temporal.io/..." + validations: + required: true + - type: textarea + id: issue-location + attributes: + label: Typo or Grammar Issue + description: Report typos, spelling mistakes, or grammar problems here. Describe the problem and your recommended solution. Specify an approximate location on the page (for example, under which heading or part of the content), and any other details that will help us locate and resolve the problem. + placeholder: "Section title, issue, suggested correction" + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/1_technical-issues.yml b/.github/ISSUE_TEMPLATE/1_technical-issues.yml new file mode 100644 index 0000000000..eedb087b85 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1_technical-issues.yml @@ -0,0 +1,30 @@ +name: Site Technical Issue +description: Report technical issues like broken links, missing media, outdated information, or problems with code examples. +labels: ["site-technical-issue"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: input + id: issue-url + attributes: + label: Page URL + description: The page where the problem occurs + placeholder: "For example, https://docs.temporal.io/..." + validations: + required: true + - type: textarea + id: issue-location + attributes: + label: Technical Issue + description: Report technical issues like broken links, missing media, outdated information, or problems with code examples here. Describe the technical issue you encountered and your recommended solution. Specify the approximate location on the page (for example, under which heading or part of the content), and any other details that will help us locate and resolve the problem. + placeholder: "Section title, issue, suggested correction" + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/2_content-issues.yml b/.github/ISSUE_TEMPLATE/2_content-issues.yml new file mode 100644 index 0000000000..0abac9aa14 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2_content-issues.yml @@ -0,0 +1,30 @@ +name: Content Correction Issue +description: "Report issues related to documentation content, including missing or incorrect information and unclear, confusing, or misleading writing." +labels: ["content-correction"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: input + id: issue-url + attributes: + label: Page URL + description: The page where the problem occurs + placeholder: "For example, https://docs.temporal.io/..." + validations: + required: true + - type: textarea + id: issue-location + attributes: + label: Content Issue + description: Report unclear, confusing, or misleading writing, or missing/incorrect information in the documentation here. Describe the content issue you encountered and your recommended solution. Specify the approximate location on the page (for example, under which heading or part of the content), and any other details that will help us locate and resolve the problem. We appreciate links to any reference material or experts that support factual changes. + placeholder: "Section title, issue, suggested correction" + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/3_improvement-suggestions.yml b/.github/ISSUE_TEMPLATE/3_improvement-suggestions.yml new file mode 100644 index 0000000000..6b232ebeff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3_improvement-suggestions.yml @@ -0,0 +1,22 @@ +name: Improvement Suggestion +description: "Suggest ways to improve, expand, or add to our content." +labels: ["improvement"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: textarea + id: issue-location + attributes: + label: Content Suggestion + description: Suggest ways to improve, add, or reorganize our content to make it clearer, better structured, and more discoverable. Please specify how you think we can improve, expand, or add to our content. + placeholder: "Help us improve" + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/4_accessibility-issues.yml b/.github/ISSUE_TEMPLATE/4_accessibility-issues.yml new file mode 100644 index 0000000000..cea74b36a4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/4_accessibility-issues.yml @@ -0,0 +1,30 @@ +name: Accessibility Issue +description: Report accessibility issues like color contrast, font readability, missing image descriptions, or screen reader problems. +labels: ["accessibility"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: input + id: issue-url + attributes: + label: Page URL + description: The page where the problem occurs + placeholder: "For example, https://docs.temporal.io/..." + validations: + required: true + - type: textarea + id: issue-location + attributes: + label: Accessibility Issue + description: Report issues related to accessibility, such as color contrast, font readability, missing image descriptions, or screen reader problems here. Describe the accessibility issue you encountered and suggest a solution. Specify an approximate location on the page (for example, under which heading or part of the content), and any other details that will help us locate and resolve the problem. If possible, suggest improvements for a better accessibility experience. + placeholder: "Section title, issue, suggested correction" + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/5_other-feedback.yml b/.github/ISSUE_TEMPLATE/5_other-feedback.yml new file mode 100644 index 0000000000..a28870d7e8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/5_other-feedback.yml @@ -0,0 +1,22 @@ +name: Other Feedback +description: Share anything, such as positive feedback or general suggestions for improvement. +labels: ["feedback"] +body: + - type: checkboxes + id: employee + attributes: + label: Temporal Affiliation + options: + - label: I am a Temporal employee + required: false + - type: textarea + id: feedback + attributes: + label: General Feedback + description: Share feedback or broad suggestions for improving the documentation here. What did you like or find helpful about our site? What suggestions do you have for making our documentation better? + placeholder: Let us know what you think! + validations: + required: true + - type: markdown + attributes: + value: "Thanks for helping us improve our documentation." diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..64a41c2cd5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,22 @@ +blank_issues_enabled: false +contact_links: + - "https://github.com/temporalio/documentation/blob/main/CONTACT.md" +templates: + - name: "Typos and Grammar" + description: "Report typos, spelling mistakes, or grammar problems." + filename: "0_typos-and-grammar.yml" + - name: "Technical Issues" + description: "Report technical issues like broken links, missing media, outdated information, or problems with code examples." + filename: "1_technical-issues.yml" + - name: "Content Clarification" + description: "Report unclear, confusing, or misleading writing, or missing/incorrect information in the documentation." + filename: "2_content-issues.yml" + - name: "Improvements and Enhancements" + description: "Suggest ways to improve, add, or reorganize our content to make it clearer, better structured, and more discoverable." + filename: "3_improvement-suggestions.yml" + - name: "Accessibility Issues" + description: "Report issues related to accessibility, such as color contrast, font readability, missing image descriptions, or screen reader problems." + filename: "4_accessibility-issues.yml" + - name: "General Suggestions" + description: "Share any other feedback, including positive comments or broad suggestions for improving the documentation." + filename: "5_other-feedback.yml" diff --git a/.github/ISSUE_TEMPLATE/documentation-request.md b/.github/ISSUE_TEMPLATE/documentation-request.md deleted file mode 100644 index 1ee2f0a1be..0000000000 --- a/.github/ISSUE_TEMPLATE/documentation-request.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -name: Documentation request -about: Use this to propose information improvements and additions -title: "[ Documentation request ] " -labels: '' -assignees: '' - ---- - -# Brief description - -Provide a description of your documentation request. - -# Your recommended content - -Add your recommended content here. Add the content directly to this page or add links to drafts. -Documentation requests that are made without any recommendations could take longer to process. diff --git a/.github/ISSUE_TEMPLATE/functionality-bug-report.md b/.github/ISSUE_TEMPLATE/functionality-bug-report.md deleted file mode 100644 index 9362ed7c99..0000000000 --- a/.github/ISSUE_TEMPLATE/functionality-bug-report.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Functionality bug report -about: Create a bug report related to the functionality of the site to help us improve -title: "[ Bug report ]" -labels: '' -assignees: '' - ---- - -## Required - -**What is the issue?** - -**How can we reproduce the issue?** - -**What is the expected behavior?** - -## Additional context (optional—the more we know, the faster it goes) - -**Screenshots:** - -**Browser and version:** - -**Device and screen size:**