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

Clarify the existing pending job is canceled #34657

Merged
merged 5 commits into from
Oct 7, 2024

Conversation

zachborboacryptofi
Copy link
Contributor

@zachborboacryptofi zachborboacryptofi commented Sep 19, 2024

Why:

Docs clarification.

Closes: N/A

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Sep 19, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Sep 19, 2024
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team more-information-needed More information is needed to complete review and removed triage Do not begin working on this issue until triaged by the team labels Sep 19, 2024
@nguyenalex836
Copy link
Contributor

@zachborboacryptofi Thank you for opening a PR! ✨ Can you elaborate on what you are hoping to clarify by adding the word "existing" to the reusable? 💛

@zachborboacryptofi
Copy link
Contributor Author

@nguyenalex836 Hi. I think adding "existing" to the pending job will help clarify the documentation, as the current wording can be a bit confusing. The update emphasizes that we're referring to any pending job or workflow that's already in place that will be canceled and not the new incoming pending job or workflow, which should make it clearer for readers.

As currently written, it reads like this:

in-progress: myConcurrencyGroup1.job1
pending: myConcurrencyGroup1.job2

+

myConcurrencyGroup1.job3

=

in-progress: myConcurrencyGroup1.job1
pending: (empty, as _any_ pending jobs or workflows were canceled)

By emphasizing that the existing pending job, if it exists, is canceled, it reads like this:

in-progress: myConcurrencyGroup1.job1
pending: myConcurrencyGroup1.job2

+

myConcurrencyGroup1.job3

=

in-progress: myConcurrencyGroup1.job1
pending: myConcurrencyGroup1.job3

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review and removed more-information-needed More information is needed to complete review labels Sep 20, 2024
@nguyenalex836
Copy link
Contributor

@zachborboacryptofi Thank you for the elaboration! I'll triage this for review so that we can get a writer to weigh in on this change as well 💛

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Sep 23, 2024
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review SME reviewed An SME has reviewed this issue/PR and removed waiting for review Issue/PR is waiting for a writer's review needs SME This proposal needs review from a subject matter expert labels Oct 7, 2024
@nguyenalex836
Copy link
Contributor

@zachborboacryptofi Thank you for those final updates! We'll get this merged 🍏

@nguyenalex836 nguyenalex836 removed the more-information-needed More information is needed to complete review label Oct 7, 2024
@nguyenalex836 nguyenalex836 added this pull request to the merge queue Oct 7, 2024
Merged via the queue into github:main with commit 3d231ae Oct 7, 2024
43 checks passed
Copy link
Contributor

github-actions bot commented Oct 7, 2024

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team SME reviewed An SME has reviewed this issue/PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants