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

dbt Cloud quickstart guides #2749

Merged
merged 48 commits into from
Mar 10, 2023
Merged

dbt Cloud quickstart guides #2749

merged 48 commits into from
Mar 10, 2023

Conversation

nghi-ly
Copy link
Contributor

@nghi-ly nghi-ly commented Jan 25, 2023

What are you changing in this pull request and why?

Similar to the dbt Core get started, update the dbt Cloud get started guides such that the Building your first models, Test and document your project, and Schedule a job are not on separate pages. After the update, the guides would be:

  • Quickstart for dbt Cloud and BigQuery
  • Quickstart for dbt Cloud and Databricks
  • Quickstart for dbt Cloud and Snowflake
  • Quickstart for dbt Cloud and Redshift

Rename "Getting started with dbt Core" to "Quickstart for dbt Core"

Checklist

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):

  • Remove page from website/sidebars.js
  • Add an entry _redirects
  • Ran link testing to update the links that point to the deleted page

@nghi-ly nghi-ly self-assigned this Jan 25, 2023
@netlify
Copy link

netlify bot commented Jan 25, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 87bcea4
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/640b9d5c7445fb0008dfbd44
😎 Deploy Preview https://deploy-preview-2749--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added content Improvements or additions to content size: large This change will more than a week to address and might require more than one person labels Jan 25, 2023
@runleonarun runleonarun added the idea Proposes an idea for new content label Jan 26, 2023
@github-actions github-actions bot added the Docs team Authored by the Docs team @dbt Labs label Feb 8, 2023
@github-actions github-actions bot added developer blog This content fits on the developer blog. guides Knowledge best suited for Guides labels Feb 9, 2023
Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

A flock of comments for everything except for Databricks, which I will do separately once Ly's finished tweaking it!

One thing that I wanted to raise: in this, we're encouraging people to set up a basic project; given that the Teams plan only allows a single project, people are going to have to either delete this one when they're done and then make another, or they'll have to tear out their temporary demo connection and rebuild their project to connect to the "correct" warehouse if they didn't from the outset.

Are we giving good/any guidance around that?

website/docs/docs/build/projects.md Outdated Show resolved Hide resolved
contributing/adding-page-components.md Outdated Show resolved Hide resolved
website/docs/docs/build/sql-models.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Show resolved Hide resolved
website/docs/docs/quickstarts/overview.md Outdated Show resolved Hide resolved
title="Quickstart for dbt Core"
body="When you use dbt Core to work with dbt, you will be editing files locally using a code editor, and running projects using a command line interface."
link="/docs/quickstarts/dbt-core/quickstart"
icon="pencil-paper"/>
Copy link
Contributor

Choose a reason for hiding this comment

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

Would be cool if there was a specialist icon here too, e.g. https://fontawesome.com/icons/square-terminal?s=solid&f=classic

website/sidebars.js Show resolved Hide resolved
Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

Looking good! Many of the notes I would have written were dupes of the same comment on the BQ model so any tweaks you make there, remember to apply to the other 3 guides 😅

website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/dbt-cloud/databricks-qs.md Outdated Show resolved Hide resolved
12. To ensure any users who might be working on your dbt project has access to your object, run this command.

```sql
grant all privileges on schema default to users;
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know enough to reject this, but it feels like a big hammer to solve a problem. Do we want to encourage people who might not be experienced DBA's to solve their problems with grant all privileges to all users?

@nghi-ly
Copy link
Contributor Author

nghi-ly commented Mar 9, 2023

hey @joellabes,

One thing that I wanted to raise: in this, we're encouraging people to set up a basic project; given that the Teams plan
only allows a single project, people are going to have to either delete this one when they're done and then make another,
or they'll have to tear out their temporary demo connection and rebuild their project to connect to the "correct"
warehouse if they didn't from the outset.

Are we giving good/any guidance around that?

no, it doesn't look like we are at the moment and is a really good point to raise. thank you. i don't think this is a blocker (but lemme know if you think it should be!) but i think is definitely something that should be followed up (added this to my list).

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@nghi-ly I read the overview and have some tiny suggestions. It reads super nicely and I expect it to really help users get started!! Nice work!

website/docs/docs/quickstarts/overview.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/overview.md Show resolved Hide resolved
website/docs/docs/quickstarts/overview.md Outdated Show resolved Hide resolved
website/docs/docs/quickstarts/overview.md Outdated Show resolved Hide resolved
runleonarun
runleonarun previously approved these changes Mar 10, 2023
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@nghi-ly a tiny suggestion non-blocking and we should capture Joel's unaddressed thoughts in follow up issues.

website/docs/docs/quickstarts/overview.md Outdated Show resolved Hide resolved
first_name,
last_name

from `dbt-tutorial`.jaffle_shop.customers
Copy link
Collaborator

Choose a reason for hiding this comment

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

@nghi-ly maybe you can create a follow-up issue to address Joel's comment here.

Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

Giving this the final :shipit:

@nghi-ly nghi-ly merged commit f7ed34d into current Mar 10, 2023
@nghi-ly nghi-ly deleted the ly-docs-bq-gsg branch March 10, 2023 22:07
@runleonarun runleonarun removed the idea Proposes an idea for new content label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content developer blog This content fits on the developer blog. Docs team Authored by the Docs team @dbt Labs guides Knowledge best suited for Guides size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants