Skip to content

docs: add jobs overwrite flag #4646

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

Merged
merged 8 commits into from
May 24, 2025

Conversation

javier-aliaga
Copy link

@javier-aliaga javier-aliaga commented May 7, 2025

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

  • Commits are signed with Developer Certificate of Origin (DCO - learn more)
  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • Page references use shortcodes instead of markdown or URL links
  • Images use HTML style and have alternative text
  • Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Issue reference

Issue - dapr/dapr#8402
PR - dapr/dapr#8701

Sorry, something went wrong.

Signed-off-by: Javier Aliaga <[email protected]>
@javier-aliaga javier-aliaga changed the title [WIP] docs: add jobs overwrite flag docs: add jobs overwrite flag May 7, 2025
@javier-aliaga javier-aliaga marked this pull request as ready for review May 7, 2025 14:59
@javier-aliaga javier-aliaga requested review from a team as code owners May 7, 2025 14:59
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.

@javier-aliaga - Commented. A few things

  1. Please put the code issue into the docs issue. I have added it in this case (Don't overwrite jobs using same name dapr#8402)

  2. Let's use this PR to update docs overview here https://docs.dapr.io/developing-applications/building-blocks/jobs/jobs-overview/

  • Under Features we really should say that the primary feature here is to create, get and delete jobs. This can be one paragraph, but in that paragraph you should mention that an existing job cannot be overwritten unless specific indicated. Write something and I will review this
  • The first sentence here is now wrong I presume https://docs.dapr.io/developing-applications/building-blocks/jobs/jobs-overview/ under "Schedule jobs across multiple replicas" - where is says "When you create a job, it replaces any existing job with the same name." Should now say "When you create a job, it does not replace an existing job with the same name, unless you explicitly set the 'overwrite' flag"
  1. Remove the "waiting on code" label once this code is merged.

@msfussell msfussell added the waiting-on-code-pr The code PR needs to be merged before the docs are updated label May 7, 2025
@msfussell msfussell added this to the 1.16 milestone May 7, 2025
javier-aliaga and others added 2 commits May 15, 2025 12:16
…bs/jobs-features-concepts.md

Co-authored-by: Mark Fussell <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
Co-authored-by: Mark Fussell <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
…bs/jobs-features-concepts.md

Co-authored-by: Josh van Leeuwen <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
javier-aliaga and others added 2 commits May 21, 2025 10:31
…bs/jobs-overview.md

Co-authored-by: Cassie Coyle <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
…bs/jobs-overview.md

Co-authored-by: Cassie Coyle <[email protected]>
Signed-off-by: Javier Aliaga <[email protected]>
…bs/jobs-overview.md

Signed-off-by: Mark Fussell <[email protected]>
@msfussell msfussell removed the waiting-on-code-pr The code PR needs to be merged before the docs are updated label May 24, 2025
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

@msfussell msfussell merged commit 8135abd into dapr:v1.16 May 24, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants