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 job-scheduler.md #6676

Merged
merged 7 commits into from
Dec 17, 2024
Merged

Update job-scheduler.md #6676

merged 7 commits into from
Dec 17, 2024

Conversation

rcg798
Copy link
Contributor

@rcg798 rcg798 commented Dec 16, 2024

Coming newly into the orchestration team, I am updating the initial description of the scheduler types to better align with how users may view the product today: 1. we refer to merge jobs as merge jobs (and it is an explicit category in the UI) so I think it would be useful to call out that term in the beginning, so people associate that type of job with its name and 2. another event-based job is job completion (another explicit category in the UI) and I couldn't tell how that fit into the initial description, so added that as well. Feel free to revise, just wanted to flag those two points! If it would be easier to flag this in Slack, let me know.

What are you changing in this pull request and why?

Checklist

  • [ x] I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

Coming newly into the orchestration team, I am updating the initial description of the scheduler types to better align with how users may view the product today: 1. we refer to merge jobs as merge jobs (and it is an explicit category in the UI) so I think it would be useful to call out that term in the beginning, so people associate that type of job with its name and 2. another event-based job is job completion (another explicit category in the UI) and I couldn't tell how that fit into the initial description, so added that as well. Feel free to revise, just wanted to flag those two points!
@rcg798 rcg798 requested a review from a team as a code owner December 16, 2024 18:06
Copy link

vercel bot commented Dec 16, 2024

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Dec 17, 2024 11:39am

@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. labels Dec 16, 2024
website/docs/docs/deploy/job-scheduler.md Outdated Show resolved Hide resolved
website/docs/docs/deploy/job-scheduler.md Outdated Show resolved Hide resolved
@@ -11,7 +11,8 @@ The job scheduler is the backbone of running jobs in dbt Cloud, bringing power a
The scheduler enables both cron-based and event-driven execution of dbt commands in the user’s data platform. Specifically, it handles:

- Cron-based execution of dbt Cloud jobs that run on a predetermined cadence
- Event-driven execution of dbt Cloud CI jobs triggered by pull requests to the dbt repo
- Event-driven execution of dbt Cloud jobs that [run based on the completion of another job ([trigger on job completion](/docs/deploy/deploy-jobs#trigger-on-job-completion))
- Event-driven execution of dbt Cloud CI jobs triggered by pull requests to the dbt repo (e.g. "merge jobs")
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.LatinAbbreviations] Avoid Latin abbreviations: 'for example'. Consider using 'e.g' instead.

@@ -11,7 +11,8 @@
The scheduler enables both cron-based and event-driven execution of dbt commands in the user’s data platform. Specifically, it handles:

- Cron-based execution of dbt Cloud jobs that run on a predetermined cadence
- Event-driven execution of dbt Cloud CI jobs triggered by pull requests to the dbt repo
- Event-driven execution of dbt Cloud jobs that [run based on the completion of another job ([trigger on job completion](/docs/deploy/deploy-jobs#trigger-on-job-completion))
- Event-driven execution of dbt Cloud CI jobs triggered by pull requests to the dbt repo (e.g. "merge jobs")
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'e.g.'?

Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

great suggestion @rcg798 ! really appreciate your contribution here and made a couple of small tweaks and merging for you!

@mirnawong1 mirnawong1 enabled auto-merge December 17, 2024 11:36
@mirnawong1 mirnawong1 merged commit b1ccd04 into current Dec 17, 2024
8 checks passed
@mirnawong1 mirnawong1 deleted the rcg798-patch-1 branch December 17, 2024 11:39
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 size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants