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

Jobs API docs, pt 3 #4243

Merged
merged 14 commits into from
Jul 29, 2024
Merged

Jobs API docs, pt 3 #4243

merged 14 commits into from
Jul 29, 2024

Conversation

hhunter-ms
Copy link
Collaborator

@hhunter-ms hhunter-ms commented Jul 8, 2024

Description

  • Add screenshots of dapr init and docker ps outputs to install doc
  • Jobs API how-to
  • Add how to consume a triggered job
    • Update API reference doc

Issue reference

PR will close: #3915

@hhunter-ms hhunter-ms added this to the 1.14 milestone Jul 8, 2024
@hhunter-ms
Copy link
Collaborator Author

@cicoyle just waiting on an example that I can base the docs how-to off of... feel free to add commits to my branch if it's easier for you to write something that I can edit later

@mikeee
Copy link
Member

mikeee commented Jul 10, 2024

@hhunter-ms - Apologies for the lack of docs input. The go-sdk implementation is available: https://github.com/dapr/go-sdk/tree/58e56c0b2cd067367a3e52b4eae4210f6d62cb74/examples/dist-scheduler

I don't anticipate any further changes client-wise.

@hhunter-ms hhunter-ms added the P0 label Jul 15, 2024
Copy link

Stale PR, paging all reviewers

@cicoyle cicoyle marked this pull request as ready for review July 25, 2024 18:34
@cicoyle cicoyle requested review from a team as code owners July 25, 2024 18:34
Signed-off-by: Hannah Hunter <[email protected]>
@hhunter-ms
Copy link
Collaborator Author

@msfussell - do you think howto-schedule-jobs.md would fit better in the Developing Applications/SDKs/Go docs? Since it's pretty much the same as howto-handle-triggered-jobs.md (which uses the Go HTTP client), but exclusively uses the SDK?

@@ -0,0 +1,223 @@
---
type: docs
title: "How-To: Handle triggered jobs"
Copy link
Member

Choose a reason for hiding this comment

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

  • Better to show the Go SDK methods rather than HTTP
  • the code here should be a snippet that simply shows the main methods calls that you want to person to focus on. There are already full code samples here jobs quickstart #4276 otherwise we are just repeating everything.
  • This HowTo (which tells you the essential points) then simply points to this code example
  • Have a couple of sentences telling the person what is happening. Also does it really need to be split into two apps? People will think is what is required, when this all can be in the same app and will be 90% of the time.
  • Also do not see why this should be split into 2 different topics. Just have one topic on "How to schedule and handle trigger jobs" (include scheduling and triggers)

log.Fatalf("failed to start server: %v", err)
}
}()
// ...
Copy link
Contributor

Choose a reason for hiding this comment

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

The spacing is showing up weird here, but looks fine in my IDE

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

it looks fine when I build locally too!

Signed-off-by: Hannah Hunter <[email protected]>
Signed-off-by: Hannah Hunter <[email protected]>
Signed-off-by: Hannah Hunter <[email protected]>
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.

LGTM

@hhunter-ms hhunter-ms merged commit 9356089 into dapr:v1.14 Jul 29, 2024
4 checks passed
@hhunter-ms hhunter-ms deleted the issue_3915-3 branch July 29, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants