studio/flamenco
studio/flamenco
12
30
Fork 38
Code Issues 64 Pull Requests 5 Releases Wiki Activity

Website: Documenting descriptions for Job and Task Statuses in the documentation webpage. #104214

Merged
Sybren A. Stüvel merged 5 commits from Adi.Sage/flamenco:updating-job-and-task-statuses into main 2023-06-22 19:41:53 +02:00
Conversation 1 Commits 5 Files Changed 1 +25 -4
Adi.Sage commented 2023-05-23 19:00:02 +02:00
Contributor
Copy Link

This is a comprehensive list of all possible job and task statuses,
along with a brief description of each status
and a list of possible next statuses.

This is a comprehensive list of all possible job and task statuses, along with a brief description of each status and a list of possible next statuses.
Adi.Sage added 1 commit 2023-05-23 19:00:05 +02:00 
in the documentation webpage.

This is a comprehensive list of all possible statuses,
along with a brief description of each status
and a list of possible next statuses.
Adi.Sage requested review from Sybren A. Stüvel 2023-05-23 19:00:35 +02:00
Adi.Sage changed title from Documenting descriptions for Job and Task Statuses in the documentation webpage. to WIP: Documenting descriptions for Job and Task Statuses in the documentation webpage. 2023-05-23 19:01:42 +02:00
Adi.Sage added 1 commit 2023-05-23 19:09:01 +02:00 
in the documentation webpage.

This is a comprehensive list of all possible statuses,
along with a brief description of each status
and a list of possible next statuses.
Adi.Sage added 1 commit 2023-05-23 19:15:39 +02:00 
as the former is not a valid status.
Also fixing a few other typos.
Adi.Sage changed title from WIP: Documenting descriptions for Job and Task Statuses in the documentation webpage. to WIP: Website: Documenting descriptions for Job and Task Statuses in the documentation webpage. 2023-05-23 19:18:35 +02:00
Adi.Sage changed title from WIP: Website: Documenting descriptions for Job and Task Statuses in the documentation webpage. to Website: Documenting descriptions for Job and Task Statuses in the documentation webpage. 2023-05-23 19:22:05 +02:00
Sybren A. Stüvel requested changes 2023-05-24 10:51:22 +02:00
Sybren A. Stüvel left a comment
Owner
Copy Link

Thanks! Just a few small notes.

Thanks! Just a few small notes.
web/project-website/content/usage/jobs-tasks-commands/_index.md Outdated
@ -8,0 +20,4 @@
| `canceled` | Canceled by the user, job terminated immediately on all Workers | `queued` |
| `requeueing` | Request for requeueing of job raised by user | `queued` |
| `archiving` | Archiving job details | `archived` |
| `archived` | Job details archived in history for future reference | `queued` |
Sybren A. Stüvel commented 2023-05-24 10:51:14 +02:00
Owner
Copy Link

As discussed on Blender Chat, the archiving and archived statuses don't have to be added to the docs, as they are left-overs from Flamenco v2 and are not used any more.

As discussed on Blender Chat, the `archiving` and `archived` statuses don't have to be added to the docs, as they are left-overs from Flamenco v2 and are not used any more.
web/project-website/content/usage/jobs-tasks-commands/_index.md
@ -19,0 +32,4 @@
| `queued` | Ready to be assigned to an available Worker | `active`, `canceled` |
| `active` | Assigned to a Worker for execution | `completed`, `canceled`, `failed`, `soft-failed` |
| `completed` | Task executed succesfully | `queued` |
| `soft-failed` | Same as `queued`, but has been failed by a Worker in an earlier execution | `completed`, `failed`, `canceled` |
Sybren A. Stüvel commented 2023-05-24 10:50:16 +02:00
Owner
Copy Link

Another possible next status would be queued, as you can re-queue a job that has a mixture of task statuses, and after requeueing those should all go to either queued or remain at completed.

FYI: requeuing a job that's completed will requeue all its tasks. When that the job was not 100% complete yet, it will only requeue the not-yet-completed tasks, and leave the completed ones alone.

Another possible next status would be `queued`, as you can re-queue a job that has a mixture of task statuses, and after requeueing those should all go to either `queued` or remain at `completed`. FYI: requeuing a job that's `completed` will requeue all its tasks. When that the job was not 100% complete yet, it will only requeue the not-yet-completed tasks, and leave the completed ones alone.
Adi.Sage commented 2023-05-25 17:26:56 +02:00
Author
Contributor
Copy Link

Noted 👍 I will remove the archive and archived as requested.

Can you elaborate on the following from your second comment :

  • Should I add 'queued' as a possible next status to all the status you have marked out?
  • And the 'FYI' part is just for me or should I add that as a description of 'completed' / 'active'?
Noted 👍 I will remove the `archive `and `archived` as requested. Can you elaborate on the following from your second comment : - Should I add 'queued' as a possible next status to all the status you have marked out? - And the 'FYI' part is just for me or should I add that as a description of 'completed' / 'active'?
Sybren A. Stüvel commented 2023-05-26 11:15:30 +02:00
Owner
Copy Link

Should I add 'queued' as a possible next status to all the status you have marked out?

It's not so clear here what I was referring to (compared to the old Phabricator-based review tool we used), my remark was purely about the soft-failed status.

And the 'FYI' part is just for me
It was intended just for you, but to be fair I do think it's a good idea if this makes it into the documentation somehow. Not sure if it looks good when added to this table, or whether it's better to write it down below that. I'll leave that choice to you. Also it could just be another PR later, if you want. Whatever is easiest for you.

> Should I add 'queued' as a possible next status to all the status you have marked out? It's not so clear here what I was referring to (compared to the old Phabricator-based review tool we used), my remark was purely about the `soft-failed` status. > And the 'FYI' part is just for me It was intended just for you, but to be fair I do think it's a good idea if this makes it into the documentation somehow. Not sure if it looks good when added to this table, or whether it's better to write it down below that. I'll leave that choice to you. Also it could just be another PR later, if you want. Whatever is easiest for you.
Adi.Sage added 1 commit 2023-06-20 20:10:14 +02:00 
- Added helpful notes for what happens
when a under-execution or completed job
is requeued by the users.
- Added 'queued' as a possible next status
for 'soft-failed'
Adi.Sage requested review from Sybren A. Stüvel 2023-06-20 20:25:10 +02:00
Sybren A. Stüvel requested changes 2023-06-22 17:04:03 +02:00
Sybren A. Stüvel left a comment
Owner
Copy Link

I'm looking forward to landing this PR :)

Only one small improvement to improve clarity & correctness of the description of what happens when requeueing a job.

I'm looking forward to landing this PR :) Only one small improvement to improve clarity & correctness of the description of what happens when requeueing a job.
web/project-website/content/usage/jobs-tasks-commands/_index.md Outdated
@ -8,0 +23,4 @@
NOTE :
- Requeueing a job after it is `completed` will requeue all its tasks.
- Requeueing a job while it is being executed will requeue the pending tasks only. The `completed` tasks will not be requeued.
Sybren A. Stüvel commented 2023-06-22 17:02:30 +02:00
Owner
Copy Link

These two are not quite accurate, I'd recomment rewording it to:

  • Requeueing a job when it is completed,i.e. when all its tasks are completed, will requeue all its tasks.
  • Requeueing a job when some its tasks are not completed will requeue these tasks only. The completed tasks will not be requeued, and will remain at completed status.
These two are not quite accurate, I'd recomment rewording it to: - Requeueing a job when it is `completed`,i.e. when all its tasks are `completed`, will requeue all its tasks. - Requeueing a job when some its tasks are not `completed` will requeue these tasks only. The `completed` tasks will not be requeued, and will remain at `completed` status.
👍 1
Adi.Sage commented 2023-06-22 19:14:43 +02:00
Author
Contributor
Copy Link

This makes much more sense. Thanks for the suggestion!

This makes much more sense. Thanks for the suggestion!
Adi.Sage added 1 commit 2023-06-22 19:10:09 +02:00 
The note added in previous commit has been revised
to be more clear and accurate as per Dr Sybren's suggestions.
Adi.Sage requested review from Sybren A. Stüvel 2023-06-22 19:11:23 +02:00
Sybren A. Stüvel merged commit 8a5c099d57 into main 2023-06-22 19:41:53 +02:00
Sybren A. Stüvel approved these changes 2023-06-22 19:42:03 +02:00
Sybren A. Stüvel commented 2023-06-22 19:42:09 +02:00
Owner
Copy Link

Thanks!

Thanks!
Sign in to join this conversation.
Reviewers
No reviewers
Sybren A. Stüvel
Labels
Clear labels   
Good First Issue
  
Priority
High

  
Priority
Low

  
Priority
Normal

  
Status
Archived

  
Status
Confirmed

  
Status
Needs Info from Developers

  
Status
Needs Information from User

  
Status
Needs Triage

  
Status
Resolved

  
Type
Bug

  
Type
Design

  
Type
Job Type
Custom Flamenco job type

  
Type
Known Issue

  
Type
Patch

  
Type
Report

  
Type
To Do

No Label
Good First Issue
Priority
High
Priority
Low
Priority
Normal
Status
Archived
Status
Confirmed
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Job Type
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: studio/flamenco#104214
No description provided.
Delete Branch "Adi.Sage/flamenco:updating-job-and-task-statuses"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?