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

Emmyoop patch 3 #857

Merged
merged 11 commits into from
Oct 19, 2021
Merged

Emmyoop patch 3 #857

merged 11 commits into from
Oct 19, 2021

Conversation

emmyoop
Copy link
Member

@emmyoop emmyoop commented Oct 11, 2021

Description & motivation

Updating docs for some dbt-core v1.0.0 changes.

dbt-labs/dbt-core#4008
dbt-labs/dbt-core#4007
dbt-labs/dbt-core#3999

To-do before merge

dbt-core v1.0.0 needs to be released

Pre-release docs

Is this change related to an unreleased version of dbt?

  • Yes: please
    • update the base branch to next
    • add Changelog components: <Changelog>[New/Changed] in v0.x.0</Changelog>
    • add links to the "New and changed documentation" section of the latest Migration Guide
  • No: please ensure the base branch is current
  • Unsure: we'll let you know!

Checklist

Renamed pages:

  • The pages have been updated in website/sidebars.js
  • The pages have unique filenames
  • Entries have been added to _redirects

@emmyoop emmyoop requested a review from annafil as a code owner October 11, 2021 17:14
@emmyoop emmyoop requested a review from jtcohen6 October 11, 2021 19:42
@emmyoop
Copy link
Member Author

emmyoop commented Oct 11, 2021

Unsure of where to put changelog entries for each change.

Copy link
Collaborator

@jtcohen6 jtcohen6 left a comment

Choose a reason for hiding this comment

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

Thank you for these updates !!

I left way too many comments. As a general rule:

  • Wherever we're documenting The Thing (model-paths, seed-properties, etc), we should include a <Changelog> item, just calling out that the config/default has been renamed
  • If we're just updating the name of a file in an example, no big deal, I don't think we need a changelog
  • In a bunch of places, the current docs refer to a limited number of places where sources/exposures/properties can be defined. Instead, we should clarify that they can be defined in any resource path, and (in the case of properties) that we highly encourage defining them in the resource path associated with the resource type they're describing. I think it's confusing to call out model-paths as an alternative / backwards-compatible option

As soon as you're happy with these docs, we can merge them into the next branch and deploy them at next.docs.getdbt.com. I'm probably going to merge #836 first, so there will be some conflicting changes to resolve/rebase, namely in the migration guide.

@@ -5,7 +5,7 @@ id: "using-jinja"

In this tutorial, we're going to take a common pattern used in SQL, and then use Jinja to improve our code.

If you'd like to work through this query, add [this CSV](https://github.com/dbt-labs/jaffle_shop/blob/master/data/raw_payments.csv) to the `data/` folder of your dbt project, and then execute `dbt seed`.
If you'd like to work through this query, add [this CSV](https://github.com/dbt-labs/jaffle_shop/blob/HEAD/seeds/raw_payments.csv) to the `seeds/` folder of your dbt project, and then execute `dbt seed`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

this will be a broken link until we update the jaffle_shop repo - what do you think of leaving this as is for now, and leaving ourselves a TODO?

Copy link
Member Author

@emmyoop emmyoop Oct 13, 2021

Choose a reason for hiding this comment

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

Copy link
Collaborator

Choose a reason for hiding this comment

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

that works!

Copy link
Collaborator

@jtcohen6 jtcohen6 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 all the hard work to get these right !!

There might be a few stragglers, which we can catch them over the next several weeks — at this point, it feels more important to get the vast majority of the updates in.

@emmyoop emmyoop merged commit fb4461c into next Oct 19, 2021
@jtcohen6 jtcohen6 added the dbt-core v1.0 Docs impact for the v1.1 release (Dec 2021) label Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dbt-core v1.0 Docs impact for the v1.1 release (Dec 2021)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants