From 63ade7805afa944a5747f774e9fb1b051e311009 Mon Sep 17 00:00:00 2001 From: Joe Markiewicz Date: Wed, 28 Aug 2024 09:08:08 -0500 Subject: [PATCH] MagicBot/documentation-updates --- .github/ISSUE_TEMPLATE/bug-report.yml | 23 ++++++- .github/ISSUE_TEMPLATE/feature-request.yml | 11 ++- .../maintainer_pull_request_template.md | 11 ++- .github/pull_request_template.md | 8 ++- .quickstart/quickstart.yml | 7 ++ README.md | 69 +++++++++---------- 6 files changed, 83 insertions(+), 46 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 17c2c545..38c56bc8 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: 🐞 Bug description: Report a bug or an issue you've found within the dbt package title: "[Bug] " -labels: ["bug", "triage"] +labels: ["type:bug"] body: - type: markdown attributes: @@ -35,6 +35,12 @@ body: description: A concise description of what you expected to happen. validations: required: true + - type: textarea + attributes: + label: Possible solution + description: Were you able to investigate and/or discover a potential fix to this bug in your investigation? If so, it would be much appreciated if you could submit code samples to show us how your fix resolved this issue. + validations: + required: false - type: textarea attributes: label: dbt Project configurations @@ -61,6 +67,19 @@ body: - other (mention it in "Additional Context") validations: required: true + - type: dropdown + id: orchestration_type + attributes: + label: How are you running this dbt package? + multiple: true + options: + - Fivetran Quickstart Data Model + - Fivetran Transformations + - dbt Core™ + - dbt Cloud™ + - other (mention it in "Additional Context") + validations: + required: true - type: textarea attributes: label: dbt Version @@ -83,6 +102,6 @@ body: description: Our team will assess this issue and let you know if we will add it to a future sprint. However, if you would like to expedite the solution, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible. options: - label: Yes. - - label: Yes, but I will need assistance and will schedule time during our [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance + - label: Yes, but I will need assistance. - label: No. required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index a1d28bbb..529e9bc5 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ name: 🎉 Feature description: Suggest a new feature for the Fivetran dbt package title: "[Feature] <title>" -labels: ["enhancement"] +labels: ["type:enhancement"] body: - type: markdown attributes: @@ -20,6 +20,13 @@ body: description: A clear and concise description of what you want to happen and why you want the new feature. validations: required: true + - type: textarea + attributes: + label: How would you implement this feature? + description: | + How would you build out this feature with your existing data? Any code examples you can provide to help accelerate development on this issue? + validations: + required: true - type: textarea attributes: label: Describe alternatives you've considered @@ -34,7 +41,7 @@ body: description: Our team will assess this feature and let you know if we will add it to a future sprint. However, if you would like to expedite the feature, we encourage you to contribute to the package via a PR. Our team will then work with you to approve and merge your contributions as soon as possible. options: - label: Yes. - - label: Yes, but I will need assistance and will schedule time during your [office hours](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) for guidance. + - label: Yes, but I will need assistance. - label: No. required: false - type: textarea diff --git a/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md index b0fa9076..32206744 100644 --- a/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md @@ -14,12 +14,11 @@ Please acknowledge that you have successfully performed the following commands l - [ ] dbt run (if incremental models are present) && dbt test Before marking this PR as "ready for review" the following have been applied: -- [ ] The appropriate issue has been linked, tagged, and properly assigned. -- [ ] All necessary documentation and version upgrades have been applied. - <!--- Be sure to update the package version in the dbt_project.yml, integration_tests/dbt_project.yml, and README if necessary. --> -- [ ] docs were regenerated (unless this PR does not include any code or yml updates). -- [ ] BuildKite integration tests are passing. -- [ ] Detailed validation steps have been provided below. +- [ ] The appropriate issue has been linked, tagged, and properly assigned +- [ ] All necessary documentation and version upgrades have been applied +- [ ] docs were regenerated (unless this PR does not include any code or yml updates) +- [ ] BuildKite integration tests are passing +- [ ] Detailed validation steps have been provided below ### Detailed Validation Please share any and all of your validation steps: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b4e7e8e0..30849fd0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -19,7 +19,13 @@ <!--- To select a checkbox you simply need to add an "x" with no spaces between the brackets (eg. [x] Yes). --> - [ ] Yes -**Provide an emoji that best describes your current mood** +**Typically there are additional maintenance changes required before this will be ready for an upcoming release. Are you comfortable with the Fivetran team making a few commits directly to your branch?** +<!--- If you select Yes this will help expedite your PR in case there are small changes required before approval. We encourage you not to use this branch in a production environment as we may make additional updates. --> +<!--- If you select No, we will not make any changes directly to your branch and will either communicate any planned changes via the PR thread or will merge your PR into a separate branch so we may make changes without modifying your branch.. --> +- [ ] Yes +- [ ] No + +**If you had to summarize this PR in an emoji, which would it be?** <!--- For a complete list of markdown compatible emojis check our this git repo (https://gist.github.com/rxaviers/7360908) --> :dancer: diff --git a/.quickstart/quickstart.yml b/.quickstart/quickstart.yml index 8d85bf9b..147ae358 100644 --- a/.quickstart/quickstart.yml +++ b/.quickstart/quickstart.yml @@ -18,3 +18,10 @@ destination_configurations: dispatch: - macro_namespace: dbt_utils search_order: [ 'spark_utils', 'dbt_utils' ] + +public_models: [ + "jira__daily_issue_field_history", + "jira__user_enhanced", + "jira__issue_enhanced", + "jira__project_enhanced" +] diff --git a/README.md b/README.md index 433bad30..d4d05a8a 100644 --- a/README.md +++ b/README.md @@ -14,17 +14,17 @@ </p> # Jira Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_jira/)) -# 📣 What does this dbt package do? +## What does this dbt package do? - Produces modeled tables that leverage Jira data from [Fivetran's connector](https://fivetran.com/docs/applications/jira) in the format described by [this ERD](https://fivetran.com/docs/applications/jira#schemainformation) and builds off the output of our [Jira source package](https://github.com/fivetran/dbt_jira_source). - Enables you to better understand the workload, performance, and velocity of your team's work using Jira issues. It performs the following actions: - - Creates a daily issue history table so you can quickly create agile reports, such as burndown charts, along any issue field. - - Enriches the core issue table with relevant data regarding its workflow and current state. - - Aggregates bandwidth and issue velocity metrics along projects and users. +- Creates a daily issue history table so you can quickly create agile reports, such as burndown charts, along any issue field. +- Enriches the core issue table with relevant data regarding its workflow and current state. +- Aggregates bandwidth and issue velocity metrics along projects and users. - Generates a comprehensive data dictionary of your source and modeled Jira data through the [dbt docs site](https://fivetran.github.io/dbt_jira/). <!--section="jira_transformation_model"--> -The following table provides a detailed list of all models materialized within this package by default. -> TIP: See more details about these models in the package's [dbt docs site](https://fivetran.github.io/dbt_jira/#!/overview?g_v=1&g_e=seeds). +The following table provides a detailed list of all models materialized within this package by default. +> TIP: See more details about these models in the package's [dbt docs site](https://fivetran.github.io/dbt_jira/#!/overview?g_v=1&g_e=seeds). | **Model** | **Description** | | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | @@ -34,15 +34,15 @@ The following table provides a detailed list of all models materialized within t | [jira__user_enhanced](https://fivetran.github.io/dbt_jira/#!/model/model.jira.jira__user_enhanced) | Each record represents a user, enriched with metrics regarding their open issues, completed issues, the projects they work on, and the velocity of their work. | <!--section-end--> -# 🎯 How do I use the dbt package? +## How do I use the dbt package? -## Step 1: Prerequisites +### Step 1: Prerequisites To use this dbt package, you must have the following: - At least one Fivetran Jira connector syncing data into your destination. - A **BigQuery**, **Snowflake**, **Redshift**, **Databricks**, or **PostgreSQL** destination. -### Databricks Dispatch Configuration +#### Databricks Dispatch Configuration If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) dispatch configuration within your `dbt_project.yml`. This is required in order for the package to accurately search for macros within the `dbt-labs/spark_utils` then the `dbt-labs/dbt_utils` packages respectively. ```yml dispatch: @@ -50,17 +50,17 @@ dispatch: search_order: ['spark_utils', 'dbt_utils'] ``` -### Database Incremental Strategies +#### Database Incremental Strategies Models in this package that are materialized incrementally are configured to work with the different strategies available to each supported warehouse. -For **BigQuery** and **Databricks All Purpose Cluster runtime** destinations, we have chosen `insert_overwrite` as the default strategy, which benefits from the partitioning capability. +For **BigQuery** and **Databricks All Purpose Cluster runtime** destinations, we have chosen `insert_overwrite` as the default strategy, which benefits from the partitioning capability. > For Databricks SQL Warehouse destinations, models are materialized as tables without support for incremental runs. -For **Snowflake**, **Redshift**, and **Postgres** databases, we have chosen `delete+insert` as the default strategy. +For **Snowflake**, **Redshift**, and **Postgres** databases, we have chosen `delete+insert` as the default strategy. > Regardless of strategy, we recommend that users periodically run a `--full-refresh` to ensure a high level of data quality. -## Step 2: Install the package +### Step 2: Install the package Include the following jira package version in your `packages.yml` file: > TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages. ```yaml @@ -69,7 +69,7 @@ packages: version: [">=0.17.0", "<0.18.0"] ``` -## Step 3: Define database and schema variables +### Step 3: Define database and schema variables By default, this package runs using your destination and the `jira` schema. If this is not where your Jira data is (for example, if your Jira schema is named `jira_fivetran`), add the following configuration to your root `dbt_project.yml` file: ```yml @@ -78,7 +78,7 @@ vars: jira_schema: your_schema_name ``` -## Step 4: Disable models for non-existent sources +### Step 4: Disable models for non-existent sources Your Jira connector may not sync every table that this package expects. If you do not have the `SPRINT`, `COMPONENT`, or `VERSION` tables synced, add the respective variables to your root `dbt_project.yml` file. Additionally, if you want to remove comment aggregations from your `jira__issue_enhanced` model, add the `jira_include_comments` variable to your root `dbt_project.yml`: ```yml vars: @@ -88,9 +88,9 @@ vars: jira_using_priorities: false # disable if you are not using priorities in Jira jira_include_comments: false # This package aggregates issue comments so that you have a single view of all your comments in the jira__issue_enhanced table. This can cause limit errors if you have a large dataset. Disable to remove this functionality. ``` -## (Optional) Step 5: Additional configurations +### (Optional) Step 5: Additional configurations -### Define daily issue field history columns +#### Define daily issue field history columns The `jira__daily_issue_field_history` model generates historical data for the columns specified by the `issue_field_history_columns` variable. By default, the only columns tracked are `status`, `status_id`, and `sprint`, but all fields found in the Jira `FIELD` table's `field_name` column can be included in this model. The most recent value of any tracked column is also captured in `jira__issue_enhanced`. If you would like to change these columns, add the following configuration to your `dbt_project.yml` file. After adding the columns to your `dbt_project.yml` file, run the `dbt run --full-refresh` command to fully refresh any existing models: @@ -102,7 +102,7 @@ vars: issue_field_history_columns: ['the', 'list', 'of', 'field', 'names'] ``` -### Adjust the field-grain for issue field history transformations if duplicate field names +#### Adjust the field-grain for issue field history transformations if duplicate field names This package provides the option to use `field_name` instead of `field_id` as the field-grain for issue field history transformations. By default, the package strictly partitions and joins issue field data using `field_id`. However, this assumes that it is impossible to have fields with the same name in Jira. For instance, it is very easy to create another `Sprint` field, and different Jira users across your organization may choose the wrong or inconsistent version of the field. As such, the `jira_field_grain` variable may be adjusted to change the field-grain behavior of the issue field history models. You may adjust the variable using the following configuration in your root dbt_project.yml. ```yml @@ -110,17 +110,17 @@ vars: jira_field_grain: 'field_name' # field_id by default ``` -### Extend the history of an issue past its closing date -This packages allows you the option to utilize a buffer variable to bring in issues past their date of close. This is because issues can be left unresolved past that date. This buffer variable ensures that this daily issue history will not cut off field updates to these particular issues. +#### Extend the history of an issue past its closing date +This packages allows you the option to utilize a buffer variable to bring in issues past their date of close. This is because issues can be left unresolved past that date. This buffer variable ensures that this daily issue history will not cut off field updates to these particular issues. -You may adjust the variable using the following configuration in your root `dbt_project.yml`. +You may adjust the variable using the following configuration in your root `dbt_project.yml`. ```yml vars: jira_issue_history_buffer: insert_number_of_months # 1 by default ``` -### Change the build schema +#### Change the build schema By default, this package builds the Jira staging models within a schema titled (`<target_schema>` + `_jira_source`) and your Jira modeling models within a schema titled (`<target_schema>` + `_jira`) in your destination. If this is not where you would like your Jira data to be written to, add the following configuration to your root `dbt_project.yml` file: ```yml @@ -131,7 +131,7 @@ models: +schema: my_new_schema_name # leave blank for just the target_schema ``` -### Change the source table references +#### Change the source table references If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable: > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_jira/blob/main/dbt_project.yml) variable declarations to see the expected names. @@ -141,7 +141,7 @@ vars: jira_<default_source_table_name>_identifier: your_table_name ``` -### Lookback Window +#### Lookback Window Records from the source can sometimes arrive late. Since several of the models in this package are incremental, by default we look back 3 days to ensure late arrivals are captured while avoiding the need for frequent full refreshes. While the frequency can be reduced, we still recommend running `dbt --full-refresh` periodically to maintain data quality of the models. To change the default lookback window, add the following variable to your `dbt_project.yml` file: @@ -152,15 +152,15 @@ vars: lookback_window: number_of_days # default is 3 ``` -## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ +### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ <details><summary>Expand for details</summary> <br> Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core setup guides](https://fivetran.com/docs/transformations/dbt#setupguide). </details> -# 🔍 Does this package have dependencies? -This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. +## Does this package have dependencies? +This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. > IMPORTANT: If you have any of these dependent packages in your own `packages.yml` file, we highly recommend that you remove them from your root `packages.yml` to avoid package version conflicts. ```yml @@ -178,16 +178,15 @@ packages: version: [">=0.3.0", "<0.4.0"] ``` -# 🙌 How is this package maintained and can I contribute? -## Package Maintenance +## How is this package maintained and can I contribute? +### Package Maintenance The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/jira/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_jira/blob/main/CHANGELOG.md) and release notes for more information on changes across versions. -## Contributions -A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions! +### Contributions +A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions. -We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package! +We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package. -# 🏪 Are there any resources available? -- If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_jira/issues/new/choose) section to find the right avenue of support for you. +## Are there any resources available? +- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_jira/issues/new/choose) section to find the right avenue of support for you. - If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW). -- Have questions or want to be part of the community discourse? Create a post in the [Fivetran community](https://community.fivetran.com/t5/user-group-for-dbt/gh-p/dbt-user-group) and our team along with the community can join in on the discussion!