Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Standard Updates #13

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Documentation Standard Updates #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5e531e
MagicBot/documentation-updates
fivetran-joemarkiewicz Aug 28, 2024
fa6ae34
Update README.md
fivetran-joemarkiewicz Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: 🐞 Bug
description: Report a bug or an issue you've found within the dbt package
title: "[Bug] <title>"
labels: ["bug", "triage"]
labels: ["type:bug"]
body:
- type: markdown
attributes:
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
contact_links:
- name: Ask a question during our office hours
url: https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours
about: Schedule time during the external office hours block with the Fivetran Analytics Engineering team for support
- name: Provide feedback to our dbt package team
url: https://www.surveymonkey.com/r/DQ7K7WW
about: Fill out our survey form to provide valuable feedback to the Fivetran team developing and maintaining the dbt packages.
- name: Fivetran connector question
url: https://support.fivetran.com/hc
about: Have a question about your connector? Check out the Fivetran support portal for more details.
Expand All @@ -10,4 +10,4 @@ contact_links:
about: Check out the dbt docs for all dbt related information
- name: Hang out in dbt Slack
url: https://www.getdbt.com/community/
about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!
about: Have a question or just want to chat with fellow data friends, join dbt Slack and hangout in the tools-fivetran channel with us!
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand All @@ -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
Expand Down
13 changes: 6 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE/maintainer_pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,16 @@ 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:
<!--- Provide the steps you took to validate your changes below. -->

### 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:
:dancer:
8 changes: 7 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
11 changes: 10 additions & 1 deletion .quickstart/quickstart.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,13 @@ destination_configurations:
databricks:
dispatch:
- macro_namespace: dbt_utils
search_order: [ 'spark_utils', 'dbt_utils' ]
search_order: [ 'spark_utils', 'dbt_utils' ]
public_models: [
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this type of data would work. I've tested it against data that looks like it's on the Slab page.
It should look like this:

public_models:
  servicenow__user_enhanced
  servicenow__change_request_enhanced
  servicenow__user_aggregated
  servicenow__problem_enhanced
  servicenow__activity_summary
  servicenow__task_enhanced
  servicenow__incident_enhanced

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @fivetran-markoteodorovic we modeled these public_models sections off of @FedorSafronov PR here.

My understanding is that these should be in a list format. The suggested yml format doesn't represent a list, but the suggested changes in this PR do as well as the following format:

public_models:
  - servicenow__user_enhanced
  - servicenow__change_request_enhanced
  - servicenow__user_aggregated
  - servicenow__problem_enhanced
  - servicenow__activity_summary
  - servicenow__task_enhanced
  - servicenow__incident_enhanced

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fivetran-markoteodorovic I'm sure that a "bulleted" list as @fivetran-joemarkiewicz wrote it will produce an array and also a json-like notation (property: ['item1', 'item2'] will also produce an array). However, I'm not sure about the notation you mentioned. It may produce a list as well, but I'm not sure.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, maybe all of theme could be parsed. If Fedors changes passed tests then this will too.

"servicenow__user_enhanced",
"servicenow__change_request_enhanced",
"servicenow__user_aggregated",
"servicenow__problem_enhanced",
"servicenow__activity_summary",
"servicenow__task_enhanced",
"servicenow__incident_enhanced"
]
Loading
Loading