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

Update sidebar, landing page, and add new pages #3899

Merged
merged 20 commits into from
Aug 10, 2023

Conversation

nghi-ly
Copy link
Contributor

@nghi-ly nghi-ly commented Aug 9, 2023

What are you changing in this pull request and why?

  • Reorganize and update the sidebar for the Deploy top-level section
  • Add new page /docs/deploy/jobs. Mentions CI jobs and Deploy jobs and includes comparison table
  • Rename /docs/deploy/job-settings to /docs/deploy/deploy-jobs
  • Delete /docs/deploy/job-triggers and fold content into /docs/deploy/deploy-jobs
  • Update cards on landing page /docs/deploy/deployments

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 website/static/_redirects
  • Ran link testing to update the links that point to the deleted page

@netlify
Copy link

netlify bot commented Aug 9, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 51487c9
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64d534432af93200089b7c04
😎 Deploy Preview https://deploy-preview-3899--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 configuration.

@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 size: large This change will more than a week to address and might require more than one person Docs team Authored by the Docs team @dbt Labs labels Aug 9, 2023
@schottj
Copy link
Contributor

schottj commented Aug 10, 2023

this looks great!!! on the overview page, let's also add a beta call out https://deploy-preview-3899--docs-getdbt-com.netlify.app/docs/deploy/jobs

website/sidebars.js Outdated Show resolved Hide resolved
@nghi-ly nghi-ly marked this pull request as ready for review August 10, 2023 17:34
@nghi-ly nghi-ly requested a review from a team as a code owner August 10, 2023 17:34
reproduce warning. afterward fix again
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.

Nice work! Wow this whole area is way easier to understand now. Thanks for all your work here. Just have some minor language suggs.

website/docs/docs/deploy/jobs.md Outdated Show resolved Hide resolved
website/docs/docs/deploy/jobs.md Outdated Show resolved Hide resolved

:::

Below is a comparison table that describes how deploy jobs and CI jobs behave differently:
Copy link
Collaborator

Choose a reason for hiding this comment

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

So glad you added this table. It really really helps with understanding benefits/limitations of each.

- [Deploy jobs](/docs/deploy/deploy-jobs)
- [Continuous integration (CI) jobs](/docs/deploy/continuous-integration)

:::tip Join our beta
Copy link
Collaborator

Choose a reason for hiding this comment

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

should this be a reusable? Just noticed it's slightly different than the one above. But maybe that's intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i thought about that too. but each one is slightly different than the other. the one here needs to include both since the page talks about diff types of dbt cloud jobs (deploy jobs, ci jobs)

@nghi-ly nghi-ly enabled auto-merge August 10, 2023 18:57
@nghi-ly nghi-ly merged commit 8e0b6b8 into current Aug 10, 2023
10 checks passed
@nghi-ly nghi-ly deleted the ly-docs-ci-sidebar-updates branch August 10, 2023 19:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto update 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.

3 participants