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

Jobs [Distributed Scheduler] API docs, pt.1 #4164

Merged
merged 80 commits into from
Jun 26, 2024
Merged

Jobs [Distributed Scheduler] API docs, pt.1 #4164

merged 80 commits into from
Jun 26, 2024

Conversation

hhunter-ms
Copy link
Collaborator

@hhunter-ms hhunter-ms commented May 28, 2024 •
edited
Loading

Description

Dist Scheduler API docs

  • New doc set for dist scheduler building block
    • Overview
    • How to
  • Add to conceptual overview
  • Add to building blocks concepts
  • Update preview feature doc
  • Update list of Alpha APIs
  • Add API reference doc
  • CLI reference doc
  • Diagrams (diagram deck will be in separate PR)
  • Control plane services
  • Update dapr init doc to include Scheduler service

Issue reference

PR will close: #3915

Related links

Quickstart doc draft PR: #4179

@hhunter-ms
start building block skeleton
53789bd 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms hhunter-ms added this to the 1.14 milestone May 28, 2024
@hhunter-ms
add more areas for docs
3e6a3de 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
alpha api doc and create reference api
0ce5172 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
update content in overview
21ebbb1 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@msfussell
Copy link
Member

Let's just call this the Scheduler API, rather than Distributed Scheduler API. All of the APIs are distributed in some way and this term is redundant.

@hhunter-ms hhunter-ms added area/scheduler waiting-on-code-pr The code PR needs to be merged before the docs are updated labels May 29, 2024
@hhunter-ms
update to just scheduler; add to preview features
7d9bbec 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms hhunter-ms closed this May 29, 2024
@hhunter-ms hhunter-ms reopened this May 29, 2024
hhunter-ms and others added 16 commits May 29, 2024 13:40
@hhunter-ms
fix links
8eee5b5 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
add diagram to overview
09b551d 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
small updates
9c07cfd 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'v1.14' into issue_3915
ba5084a 
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms
add cli doc
a371dae 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'issue_3915' of https://github.com/hhunter-ms/docs into …
2f98a0b 
…issue_3915
@hhunter-ms
add template for scheduler service doc
95166c8 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
add table row for schedule
7e842cf 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
update kubernetes architecture image with scheduler service
deb7ade 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
update vms architecture image with scheduler service
3eed1ca 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
add scheduler to standalone overview diagram
7cdda03 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
update image for overview
81348b7 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'v1.14' into issue_3915
f2da80c
@hhunter-ms
remove dapr-jobs cli doc
f5abc17 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'issue_3915' of https://github.com/hhunter-ms/docs into …
49916d8 
…issue_3915
@hhunter-ms
add to api doc
712baca 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
hhunter-ms and others added 12 commits June 25, 2024 10:07
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
4b3e1b7 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
d975152 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
12b3e8f 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
f98286e 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
c195683 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
604b8cb 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
477416a 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms
mark review
84b19c9 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'v1.14' into issue_3915
5948f43
@hhunter-ms
remove app id from job api doc
9e897cd 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
@hhunter-ms
Merge branch 'issue_3915' of https://github.com/hhunter-ms/docs into …
962ea8b 
…issue_3915
@hhunter-ms
Merge branch 'v1.14' into issue_3915
c495f32
@hhunter-ms hhunter-ms mentioned this pull request Jun 25, 2024
Closed
13 tasks
msfussell
msfussell reviewed Jun 26, 2024
View reviewed changes
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

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

Getting really close now!

daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-overview.md Outdated Show resolved Hide resolved
daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-overview.md Outdated Show resolved Hide resolved
daprdocs/content/en/concepts/dapr-services/scheduler.md Show resolved Hide resolved
daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-overview.md Outdated Show resolved Hide resolved
daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-overview.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/jobs_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/jobs_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/jobs_api.md Outdated Show resolved Hide resolved
daprdocs/content/en/reference/api/jobs_api.md Outdated Show resolved Hide resolved
daprdocs/static/images/overview-standalone.png Outdated Show resolved Hide resolved
hhunter-ms and others added 11 commits June 26, 2024 17:15
@hhunter-ms @msfussell
Update daprdocs/content/en/developing-applications/building-blocks/jo…
c971f41 
…bs/jobs-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/developing-applications/building-blocks/jo…
9f39ecc 
…bs/jobs-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/concepts/dapr-services/scheduler.md
6cda06d 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/developing-applications/building-blocks/jo…
5d26ab5 
…bs/jobs-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/developing-applications/building-blocks/jo…
8c1778f 
…bs/jobs-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/developing-applications/building-blocks/jo…
6ad9ffe 
…bs/jobs-overview.md

Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
b661c6b 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
e686f50 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
a70cf0c 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms @msfussell
Update daprdocs/content/en/reference/api/jobs_api.md
85297f3 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms
mark review
65cd90c 
Signed-off-by: Hannah Hunter <hannahhunter@microsoft.com>
msfussell
msfussell approved these changes Jun 26, 2024
View reviewed changes
Copy link
Member

@msfussell msfussell left a comment

Choose a reason for hiding this comment

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

Fantastic to get this first part complete!

@hhunter-ms @msfussell
Update daprdocs/content/en/operations/support/alpha-beta-apis.md
9f63396 
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Signed-off-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
@hhunter-ms hhunter-ms merged commit 1c0c552 into dapr:v1.14 Jun 26, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cicoyle cicoyle cicoyle approved these changes

@msfussell msfussell msfussell approved these changes

Assignees

@cicoyle cicoyle

@hhunter-ms hhunter-ms

Labels
area/scheduler
Projects
None yet
Milestone
1.14
Development

Successfully merging this pull request may close these issues.
3 participants
@hhunter-ms @msfussell @cicoyle