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.

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

shorten field descriptions #11

Merged
merged 11 commits into from
Jul 26, 2023
Merged

Conversation

fivetran-reneeli
Copy link
Contributor

@fivetran-reneeli fivetran-reneeli commented Jul 18, 2023

PR Overview

This PR will address the following Issue/Feature:
fivetran/dbt_app_reporting#18
This PR will result in the following new package version: v0.3.1

Updates the description for field source_type to reduce the number of characters. As such this is not a breaking change.

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:
See above

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

  • dbt compile
  • dbt run –full-refresh
  • dbt run
  • dbt test
  • dbt run –vars (if applicable)

Before marking this PR as "ready for review" the following have been applied:

  • The appropriate issue has been linked and tagged
  • You are assigned to the corresponding issue and this PR
  • BuildKite integration tests are passing

Detailed Validation

Please acknowledge that the following validation checks have been performed prior to marking this PR as "ready for review":

  • You have validated these changes and assure this PR will address the respective Issue/Feature.
  • You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
  • You have provided details below around the validation steps performed to gain confidence in these changes.

View new docs

Standard Updates

Please acknowledge that your PR contains the following standard updates:

  • Package versioning has been appropriately indexed in the following locations:
    • indexed within dbt_project.yml
    • indexed within integration_tests/dbt_project.yml
  • CHANGELOG has individual entries for each respective change in this PR
  • [n/a] README updates have been applied (if applicable)
  • [n/a] DECISIONLOG updates have been updated (if applicable)
  • Appropriate yml documentation has been added (if applicable)

dbt Docs

Please acknowledge that after the above were all completed the below were applied to your branch:

  • docs were regenerated (unless this PR does not include any code or yml updates)

If you had to summarize this PR in an emoji, which would it be?

💃

@fivetran-reneeli
Copy link
Contributor Author

  • dbt docs after review is completed

Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

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

Thanks for working through this @fivetran-reneeli! There are just a few updates needed before this is good to go. Once these are applied feel free to regen the docs and let me know it is ready for re-review.

Thanks!

CHANGELOG.md Show resolved Hide resolved
Comment on lines 29 to 32
models:
+persist_docs:
relation: true
columns: true
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you also add the databricks conditional logic to be consistent across implementations.

Suggested change
models:
+persist_docs:
relation: true
columns: true
models:
+persist_docs:
relation: "{{ false if target.type in ('spark','databricks') else true }}"
columns: "{{ false if target.type in ('spark','databricks') else true }}"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added!

Copy link
Collaborator

@fivetran-joemarkiewicz fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

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

Thanks for making the updates @fivetran-reneeli. I do have one small clarifying question about the new description for source_type as it seems we are missing some types that were in the original. Can you update the description to match the previous types. Or if they were removed intentionally, please share the reasoning.

Once the description is updated or the reasoning is provided, this will be good to go!

models/docs.md Outdated
- App Clip: Users tapped a link in your App Clip that brought them to your App Store product page. If the user then downloaded your app, the resulting Download is attributed to your App Clip as the source.
- Web Referrer: Users tapped a link from a website that brought them to your App Store product page. If a chain of redirects in Safari leads to your App Store product page, the referring website will be the last URL in the chain.
- Null: This is the default value for data that does not provide source types, including: crashes, subscription events and subscription summary.
There are five types of sources: App Store Browse, App Store Search, App Referrers, Web Referrers, and App Clips. Null is the default value for data that does not provide source types, including: crashes, subscription events and subscription summary.
Copy link
Collaborator

Choose a reason for hiding this comment

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

You mention there are 5 types; however, it looks like the original description had 8. Were the three other intentionally removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmm that's true... when I went on the apple store docs, this is what is said basically verbatim
https://developer.apple.com/app-store/measuring-app-performance/
image

But if I click on the link for more info it does reference Unavailable, Institutional Purchases, and Null. I'll add these in, better to catch more just in case

@fivetran-reneeli fivetran-reneeli merged commit 99829f8 into main Jul 26, 2023
@fivetran-reneeli fivetran-reneeli deleted the bugfix/persist_docs_max_length branch July 26, 2023 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants