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

clarify build on docs content and move doc to dag section #5633

Merged
merged 60 commits into from
Jun 12, 2024

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jun 10, 2024

this pr sets to update the following items to clarify dbt explorer and dbt docs usage as there's been confusion per user feedback:

  • updates artifacts page to mention dbt explorer, updates screenshots
  • updates documentation page to mention explorer and clarifies which configs are avaialble for egacy docs.
  • moves documentation page to 'build your dag' so it follows dbt workflows
  • reworks 'build your docs in dbt cloud' and keeps it under 'collaborate.
  • renames 'explore dbt projects' to 'navigate dbt explorer' so the product/feature name is visible in docs.
  • updates the links and adds redirects

Resolves #4882
Resolves #5304
docs project

@mirnawong1 mirnawong1 requested a review from a team as a code owner June 10, 2024 13:19
Copy link

vercel bot commented Jun 10, 2024

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

Name Status Preview Comments Updated (UTC)
docs-getdbt-com 🛑 Canceled (Inspect) Jun 12, 2024 5:04pm

@github-actions github-actions bot added content Improvements or additions to content developer blog This content fits on the developer blog. guides Knowledge best suited for Guides Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person labels Jun 10, 2024
- There has been at least one successful job run in the deployment environment. Note that [CI jobs](/docs/deploy/ci-jobs) do not update dbt Explorer.
- You are on the dbt Explorer page. To do this, select **Explore** from the top navigation bar in dbt Cloud.

- You have at least one successful job run in the deployment environment. Refer to [set up a documentation job](/docs/collaborate/set-up-doc-job) for details on how set up a job run. Note that [CI jobs](/docs/deploy/ci-jobs) do not update dbt Explorer.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

confirm for tech accuracy

Copy link
Contributor

Choose a reason for hiding this comment

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

this looks right to me

website/sidebars.js Outdated Show resolved Hide resolved
website/vercel.json Outdated Show resolved Hide resolved
---

Good documentation for your dbt models will help downstream consumers discover and understand the datasets which you curate for them.
dbt provides a way to generate documentation for your dbt project and render it as a website.

## Related documentation
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we move this to the bottom while we're here, since that's where we usually place it?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

tbh i did think that but the other 'build' docs have this format so left it so it would be consistent for users.

mirnawong1 and others added 9 commits June 12, 2024 16:02
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Co-authored-by: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
@@ -2,6 +2,11 @@
"cleanUrls": true,
"trailingSlash": false,
"redirects": [
{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

added this just in case

@mirnawong1 mirnawong1 enabled auto-merge (squash) June 12, 2024 16:45
@mirnawong1 mirnawong1 disabled auto-merge June 12, 2024 16:49
mirnawong1 and others added 3 commits June 12, 2024 17:50
this pr updates the doc sharing faq to provide users the available
options to view documentation (explorer and dbt docs)
@mirnawong1 mirnawong1 enabled auto-merge (squash) June 12, 2024 16:55
@mirnawong1 mirnawong1 merged commit 56118a2 into current Jun 12, 2024
11 checks passed
@mirnawong1 mirnawong1 deleted the mwong-update-build-docs branch June 12, 2024 17:04
Copy link
Contributor

Check your created Crawler

Check your created index on your Algolia Application

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 trigger-crawl
Projects
None yet
4 participants