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

Jump to bottom

[Minor] Cannot save new file because main branch. unclear instructions. #4289

Closed
1 task done
asarraf opened this issue Oct 16, 2023 · 1 comment · Fixed by #4304
Closed
1 task done

[Minor] Cannot save new file because main branch. unclear instructions. #4289

asarraf opened this issue Oct 16, 2023 · 1 comment · Fixed by #4304
Labels
content Improvements or additions to content

Comments

@asarraf
Copy link
Contributor

asarraf commented Oct 16, 2023 •
edited by dbeatty10
Loading

Contributions

  • I have read the contribution docs, and understand what's expected of me.

What page(s) or areas on docs.getdbt.com are affected?

https://docs.getdbt.com/quickstarts/bigquery?step=7

Specifically,
https://github.com/dbt-labs/docs.getdbt.com/blob/5c40a44b3f5b414be23f813bd108d97dfb38242c/website/docs/quickstarts/bigquery-qs.md?plain=1#L106C7-L106C7

Problem Statement:

When I try to create a new file, it doesn't allow me to because by default we are on the main branch.

RCA

To create a new file, we have to first create a new branch from the main branch and then edit it.

What changes are you suggesting?

Solution

Update the documents to indicate that a new branch is to be created if we want to create a file. We cannot by default add to the main branch.

Alternate Solution:

Add FAQ to answer the query to understand, why I cannot create a new file.

Additional information

No response
@asarraf asarraf added bug Something isn't working engineering improvement that requires site engineering help or back up labels Oct 16, 2023
@asarraf
Copy link
Contributor Author

asarraf commented Oct 18, 2023

All we want to do is to dbt run and check in the BigQuery if the models are created.
We will leave the creation of a new file to the next step Build your first model

@asarraf asarraf changed the title [Minor] Cannot create new file because main branch [Minor] Cannot save new file because main branch. unclear instructions. Oct 19, 2023
@asarraf asarraf mentioned this issue Oct 19, 2023
Merged
2 tasks
@dbeatty10 dbeatty10 added content Improvements or additions to content and removed bug Something isn't working engineering improvement that requires site engineering help or back up labels Oct 23, 2023
matthewshaver added a commit that referenced this issue Oct 24, 2023
@matthewshaver
Ensure learners don't try to save a new file in main branch (#4304)
e1be0a1 
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
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
so my content adheres to these guidelines.
- [x] Needs testing the Doc Changes match `dbt cloud` UI.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content Improvements or additions to content
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Ensure learners don't try to save a new file in main branch asarraf/docs.getdbt.com
2 participants
@asarraf @dbeatty10