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

updates to the project docs naming and organization + wrote new project setup instructions for dbt cloud #366

Merged
merged 4 commits into from
Sep 16, 2024

Conversation

britt-allen
Copy link
Contributor

fixes #275

Copy link
Contributor

@JamesSLogan JamesSLogan left a comment

Choose a reason for hiding this comment

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

Thanks Britt, the new documentation looks good with a few small corrections needed. I am getting 404s for the following:
images/environment_variables.png
local-setup.md
snowflake-project-setup.md

docs/dbt.md Outdated Show resolved Hide resolved
docs/dbt.md Outdated Show resolved Hide resolved
docs/dbt.md Outdated Show resolved Hide resolved
docs/dbt.md Outdated Show resolved Hide resolved
@britt-allen
Copy link
Contributor Author

Thanks Britt, the new documentation looks good with a few small corrections needed. I am getting 404s for the following: images/environment_variables.png local-setup.md snowflake-project-setup.md

I am not sure why, it renders for me locally with no problem.

@JamesSLogan
Copy link
Contributor

I am not sure why, it renders for me locally with no problem.

If the files are present on your local branch but not github, is there any chance they aren't getting committed?

@britt-allen
Copy link
Contributor Author

Thanks for review and feedback @JamesSLogan! I think this is ready now

@JamesSLogan
Copy link
Contributor

Almost there - mkdocs now shows me these messages:

WARNING -  Doc file 'code-review.md' contains a relative link './setup.md#install-dependencies', but the target 'setup.md' is not found among documentation files.
WARNING -  Doc file 'snowflake-project-setup.md' contains a relative link './setup.md#aws', but the target 'setup.md' is not found among documentation files.

I believe these 2 links need to be to local-setup instead of setup now.

Copy link
Contributor

@JamesSLogan JamesSLogan left a comment

Choose a reason for hiding this comment

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

Looks great

@britt-allen
Copy link
Contributor Author

Thanks for catching and flagging those warnings @JamesSLogan and for all the feedback and review.

@britt-allen britt-allen merged commit 042dc73 into main Sep 16, 2024
4 checks passed
@ian-r-rose
Copy link
Member

Nice work @britt-allen!

@ian-r-rose ian-r-rose deleted the dse_docs_updates branch October 1, 2024 22:07
@britt-allen
Copy link
Contributor Author

Thanks @ian-r-rose!

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.

Add dbt project setup to DSE docs
3 participants