Ensure learners don't try to save a new file in main branch #4304

asarraf · 2023-10-19T00:08:48Z

Updated instructions to ensure that the learners don't struggle with creating new files in the main branch.

Resolves #4289

What are you changing in this pull request and why?

While trying the dbt BigQuery Quickstart I struggled with the instructions around creating and saving new file.
Because I was in the main branch, I could not save a new file.
And unless I save it, DBT doesn't materialize it as a table when we do dbt run
So, there is no point in creating a new file in this section, when we are already doing that in the next section.

This change with prevent confusion for the learner.

Also, we are creating a new branch and a new file in the next section. So the things will be clearer.

Checklist

Review the Content style guide and About versioning so my content adheres to these guidelines.
Needs testing the Doc Changes match dbt cloud UI.

Updated instructions to ensure that the learners don't struggle with creating new files in the main branch.

vercel · 2023-10-19T00:08:53Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 24, 2023 8:11pm

asarraf · 2023-10-19T01:14:07Z

website/docs/quickstarts/bigquery-qs.md

@@ -88,7 +88,7 @@ In order to let dbt connect to your warehouse, you'll need to generate a keyfile
 4. Click **Upload a Service Account JSON File** in settings.
 5. Select the JSON file you downloaded in [Generate BigQuery credentials](#generate-bigquery-credentials) and dbt Cloud will fill in all the necessary fields.
 6. Click **Test Connection**. This verifies that dbt Cloud can access your BigQuery account.
-7. Click **Next** if the test succeeded. If it failed, you might need to go back and regenerate your BigQuery credentials.
+7. Click **Next** if the test succeeded. If it fails, you might need to go back and regenerate your BigQuery credentials.


Grammatical Error Correction.

asarraf · 2023-10-19T01:14:19Z

website/docs/quickstarts/bigquery-qs.md

@@ -100,13 +100,10 @@ Now that you have a repository configured, you can initialize your project and s

 1. Click **Start developing in the IDE**. It might take a few minutes for your project to spin up for the first time as it establishes your git connection, clones your repo, and tests the connection to the warehouse.
 2. Above the file tree to the left, click **Initialize dbt project**. This builds out your folder structure with example models.
-3. Make your initial commit by clicking **Commit and sync**. Use the commit message `initial commit` and click **Commit**. This creates the first commit to your managed repo and allows you to open a branch where you can add new dbt code.
+3. Make your initial commit by clicking **Commit and sync**. Use the commit message `initial commit` and click **Commit**. This creates the first commit to your managed repo and allows you to open a branch where you can add a new dbt code.


Grammatical error Fix.

asarraf · 2023-10-19T01:14:32Z

website/docs/quickstarts/bigquery-qs.md

 4. You can now directly query data from your warehouse and execute `dbt run`. You can try this out now:
-    - Click **+ Create new file**, add this query to the new file, and click **Save as** to save the new file:  


Addressing the issue.

@anksu2024 Removing this might muddle the instructions. Would it be better to direct the customer to put this on a different branch?

I followed the instructions and the same thing we are doing in the next section. i.e. we create a new branch and our first model on the branch. Hence, it would be a redundant activity, and the learner's flow would become more streamlined with this change.

As a learner myself, I struggled for some time with this. Hence, I thought of adding.

@matthewshaver : Following up on this. Thx.

@anksu2024 Thank you for that perspective. I agree with the changes, but we must make some more adjustments to this section due to removing the text. I'll merge directly here.

Nevermind! I see you added it, Thank you!

website/docs/quickstarts/bigquery-qs.md

…file_in_main_branch

Updated the heading to reflect what the section does.

asarraf · 2023-10-24T03:41:28Z

website/docs/quickstarts/bigquery-qs.md



 ## Set up a dbt Cloud managed repository 
 <Snippet path="tutorial-managed-repo" />


-## Initialize your dbt project and start developing
+## Initialize your dbt project


Removing this from here because we are starting development next section onwards.
We are making this section straightforward to follow.

…file_in_main_branch

website/docs/quickstarts/bigquery-qs.md

…file_in_main_branch

matthewshaver · 2023-10-24T19:58:53Z

Approved! Will inspect the final preview once it's ready and then merge. Thank you @anksu2024 !

ensure learners don't try to create a new file in main file

f8d196e

Updated instructions to ensure that the learners don't struggle with creating new files in the main branch.

asarraf requested a review from a team as a code owner October 19, 2023 00:08

github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides size: small This change will take 1 to 2 days to address labels Oct 19, 2023

vercel bot deployed to Preview October 19, 2023 00:16 View deployment

asarraf commented Oct 19, 2023

View reviewed changes

website/docs/quickstarts/bigquery-qs.md Show resolved Hide resolved

asarraf commented Oct 19, 2023

View reviewed changes

website/docs/quickstarts/bigquery-qs.md Show resolved Hide resolved

asarraf changed the title ~~ensure learners don't try to create a new file in main file~~ ensure learners don't try to save a new file in main branch Oct 19, 2023

asarraf changed the title ~~ensure learners don't try to save a new file in main branch~~ Ensure learners don't try to save a new file in main branch Oct 19, 2023

matthewshaver reviewed Oct 19, 2023

View reviewed changes

website/docs/quickstarts/bigquery-qs.md Outdated Show resolved Hide resolved

Update website/docs/quickstarts/bigquery-qs.md

ee04d8b

vercel bot deployed to Preview October 19, 2023 23:37 View deployment

asarraf requested a review from matthewshaver October 21, 2023 21:55

Merge branch 'current' into resolve_instructions_around_creating_new_…

fa72e99

…file_in_main_branch

vercel bot deployed to Preview October 22, 2023 22:26 View deployment

Merge branch 'current' into resolve_instructions_around_creating_new_…

0c105bc

…file_in_main_branch

vercel bot deployed to Preview October 23, 2023 23:57 View deployment

Update bigquery-qs.md

a24dc9c

Updated the heading to reflect what the section does.

asarraf commented Oct 24, 2023

View reviewed changes

vercel bot deployed to Preview October 24, 2023 03:46 View deployment

Merge branch 'current' into resolve_instructions_around_creating_new_…

fc907eb

…file_in_main_branch

vercel bot deployed to Preview October 24, 2023 09:32 View deployment

matthewshaver reviewed Oct 24, 2023

View reviewed changes

website/docs/quickstarts/bigquery-qs.md Outdated Show resolved Hide resolved

Update website/docs/quickstarts/bigquery-qs.md

6e93a69

matthewshaver approved these changes Oct 24, 2023

View reviewed changes

Merge branch 'current' into resolve_instructions_around_creating_new_…

0da0ba9

…file_in_main_branch

vercel bot deployed to Preview October 24, 2023 20:11 View deployment

matthewshaver merged commit e1be0a1 into dbt-labs:current Oct 24, 2023
4 checks passed

asarraf deleted the resolve_instructions_around_creating_new_file_in_main_branch branch October 24, 2023 22:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure learners don't try to save a new file in main branch #4304

Ensure learners don't try to save a new file in main branch #4304

asarraf commented Oct 19, 2023 •

edited by dbeatty10

Loading

vercel bot commented Oct 19, 2023 •

edited

Loading

asarraf Oct 19, 2023 •

edited

Loading

asarraf Oct 19, 2023

asarraf Oct 19, 2023

matthewshaver Oct 19, 2023

asarraf Oct 21, 2023 •

edited

Loading

asarraf Oct 23, 2023

matthewshaver Oct 24, 2023

matthewshaver Oct 24, 2023

asarraf Oct 24, 2023

matthewshaver commented Oct 24, 2023 •

edited

Loading

		4. You can now directly query data from your warehouse and execute `dbt run`. You can try this out now:
		- Click + Create new file, add this query to the new file, and click Save as to save the new file:

Ensure learners don't try to save a new file in main branch #4304

Ensure learners don't try to save a new file in main branch #4304

Conversation

asarraf commented Oct 19, 2023 • edited by dbeatty10 Loading

What are you changing in this pull request and why?

Checklist

vercel bot commented Oct 19, 2023 • edited Loading

asarraf Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

asarraf Oct 19, 2023

Choose a reason for hiding this comment

asarraf Oct 19, 2023

Choose a reason for hiding this comment

matthewshaver Oct 19, 2023

Choose a reason for hiding this comment

asarraf Oct 21, 2023 • edited Loading

Choose a reason for hiding this comment

asarraf Oct 23, 2023

Choose a reason for hiding this comment

matthewshaver Oct 24, 2023

Choose a reason for hiding this comment

matthewshaver Oct 24, 2023

Choose a reason for hiding this comment

asarraf Oct 24, 2023

Choose a reason for hiding this comment

matthewshaver commented Oct 24, 2023 • edited Loading

asarraf commented Oct 19, 2023 •

edited by dbeatty10

Loading

vercel bot commented Oct 19, 2023 •

edited

Loading

asarraf Oct 19, 2023 •

edited

Loading

asarraf Oct 21, 2023 •

edited

Loading

matthewshaver commented Oct 24, 2023 •

edited

Loading