From 7319aee3c6e1d3f5c9071edd84216f46601956b1 Mon Sep 17 00:00:00 2001 From: "Leona B. Campbell" <3880403+runleonarun@users.noreply.github.com> Date: Thu, 14 Mar 2024 08:40:15 -0700 Subject: [PATCH] Core issue template (#5076) ## What are you changing in this pull request and why? Creating an issue template for Core so we can label appropriately --------- Co-authored-by: Mirna Wong <89008547+mirnawong1@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/external-core-team.yml | 50 +++++++++++++++++++ .github/ISSUE_TEMPLATE/improve-the-site.yml | 42 ---------------- 2 files changed, 50 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/external-core-team.yml delete mode 100644 .github/ISSUE_TEMPLATE/improve-the-site.yml diff --git a/.github/ISSUE_TEMPLATE/external-core-team.yml b/.github/ISSUE_TEMPLATE/external-core-team.yml new file mode 100644 index 00000000000..51460952c6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/external-core-team.yml @@ -0,0 +1,50 @@ +name: dbt Core - Request changes to docs +description: File a docs update request that is not already tracked in Orch team's Release Plans (Notion database). +title: "[Core] " +labels: ["content","dbt Core"] +body: + - type: markdown + attributes: + value: | + Thank you for opening a dbt Core documentation issue! Here are a few things to consider: + * You can submit ideas or suggest changes to our content by opening an [Issue](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose). + * Before filing an issue, please [search our current issues](https://github.com/dbt-labs/docs.getdbt.com/issues) to avoid duplicates. + * Please read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing) if you want to open a pull request. + * If known, add the `priority: high/medium/low` label (Optional) + + - type: textarea + attributes: + label: Link to the page(s) on docs.getdbt.com requiring updates + description: "Please link to the page or pages you'd like to see improved." + validations: + required: true + + - type: textarea + attributes: + label: Tell us more about this update + description: | + - Give as much detail as you can to help us understand the change you want to see. + - What use cases does it support? Can you provide or link to an example? + - Why is this change important? + validations: + required: true + + - type: textarea + attributes: + label: Reviewers/Stakeholders/SMEs + description: List the reviewers, stakeholders, and subject matter experts (SMEs) to collaborate with for the docs update. + validations: + required: true + + - type: textarea + attributes: + label: Related GitHub issues + description: Add any other context or screenshots about the feature request here. + validations: + required: false + - type: textarea + attributes: + label: Additional information + description: Provide any additional information, configuration, or data that might be necessary to reproduce the issue. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.yml b/.github/ISSUE_TEMPLATE/improve-the-site.yml deleted file mode 100644 index 01ebdea711a..00000000000 --- a/.github/ISSUE_TEMPLATE/improve-the-site.yml +++ /dev/null @@ -1,42 +0,0 @@ -name: Report a docs.getdbt.com site issue -description: Report a problem about the technical implementation of docs.getdbt.com. -labels: ["engineering","bug"] -body: - - type: markdown - attributes: - value: | - * You can ask questions or submit ideas for the dbt docs in [Issues](https://github.com/dbt-labs/docs.getdbt.com/issues/new/choose) - * Before you file an issue read the [Contributing guide](https://github.com/dbt-labs/docs.getdbt.com#contributing). - * Check to make sure someone hasn't already opened a similar [issue](https://github.com/dbt-labs/docs.getdbt.com/issues). - - - type: checkboxes - id: contributions - attributes: - label: Contributions - description: Please read the contribution docs before opening an issue or pull request. - options: - - label: I have read the contribution docs, and understand what's expected of me. - - - type: textarea - attributes: - label: What page(s) or areas on docs.getdbt.com are affected? - description: Include links to pages where you're seeing a problem or making a suggestion. Also include screenshots, what browser you're using, etc. - validations: - required: true - - - type: textarea - attributes: - label: What changes are you suggesting? - description: | - - Give as much detail as you can to help us understand the change you want to see. - - Why should the docs be changed? - - What is the expected outcome? - validations: - required: true - - - type: textarea - attributes: - label: Additional information - description: Any additional information, configuration, or data that might be necessary to reproduce the issue. - validations: - required: false