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

Retire the term "task jobs" #352

Closed
oliver-sanders opened this issue Nov 30, 2021 · 4 comments · Fixed by cylc/cylc-flow#5088 or #528
Closed

Retire the term "task jobs" #352

oliver-sanders opened this issue Nov 30, 2021 · 4 comments · Fixed by cylc/cylc-flow#5088 or #528
Assignees
Labels
content Addition or modification of documentation small
Milestone

Comments

@oliver-sanders
Copy link
Member

We define "tasks" and "jobs" as well as explaining the relationship between them.

The undefined term "task jobs" appears throughout the docs (and beyond). When I was starting out this term confused me, it's unclear how the term "job" differs from "task job". If we mean jobs we should just say jobs.

This term made a little more sense in Cylc 7 where tasks and jobs were more convoluted.

Propose removing this term, replacing it with either task or job as applicable.

@oliver-sanders oliver-sanders added content Addition or modification of documentation question Further information is requested labels Nov 30, 2021
@MetRonnie MetRonnie changed the title task jobs: retire term Retire the term "task jobs" Feb 7, 2022
@MetRonnie MetRonnie added this to the 8.x milestone Feb 7, 2022
@hjoliver
Copy link
Member

hjoliver commented Mar 15, 2022

The original intent of the term was to indicate that jobs are owned by particular tasks, like for other terms such as:

  • task definition
  • task environment section
  • task job script
  • (e.t.c.)
  • task job

I think it makes some sense in that light, but if others find it confusing I don't particularly mind reverting to plain old job.

It wasn't because "tasks and jobs were more convoluted" in Cylc 7 - they weren't really, as far as the scheduler was concerned, it's just that the Cylc 7 GUI did not make the distinction.

@oliver-sanders
Copy link
Member Author

Kinda get that, but why task-jobs and not cycle-tasks or workflow-cycles or workflow//cycle/task/job, seems clearer to pull these concepts apart to me.

(Would also like to consider breaking the task-job mapping in the future as part of sub-workflows and auto-batched job submission.)

Propose:

  • task job -> job [1]
  • task job script -> job script [1]
  • task job log -> job log [1]
  • task job environment -> job environment

[1] Currently defined in the glossary

@hjoliver
Copy link
Member

Yep, I'm good with that.

@oliver-sanders oliver-sanders added small and removed question Further information is requested labels Mar 18, 2022
@oliver-sanders oliver-sanders modified the milestones: pending, 8.x Aug 15, 2022
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this issue Aug 18, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and
  jobs not "task-jobs" or "cycle-tasks" or "workflow-cycles".
@oliver-sanders oliver-sanders self-assigned this Aug 18, 2022
@oliver-sanders oliver-sanders modified the milestones: 8.x, 8.1.0 Aug 18, 2022
oliver-sanders added a commit to oliver-sanders/cylc-flow that referenced this issue Aug 18, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc/cylc-doc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and jobs
  not "task-jobs" or "cycle-tasks" or "workflow-cycles".
oliver-sanders added a commit to oliver-sanders/cylc-flow that referenced this issue Aug 25, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc/cylc-doc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and jobs
  not "task-jobs" or "cycle-tasks" or "workflow-cycles".
@MetRonnie
Copy link
Member

I don't think this is rightfully closed, waiting on #528?

@MetRonnie MetRonnie reopened this Sep 15, 2022
wxtim pushed a commit to wxtim/cylc that referenced this issue Oct 3, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc/cylc-doc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and jobs
  not "task-jobs" or "cycle-tasks" or "workflow-cycles".
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this issue Oct 6, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and
  jobs not "task-jobs" or "cycle-tasks" or "workflow-cycles".
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this issue Oct 6, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and
  jobs not "task-jobs" or "cycle-tasks" or "workflow-cycles".
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this issue Oct 6, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and
  jobs not "task-jobs" or "cycle-tasks" or "workflow-cycles".
@MetRonnie MetRonnie removed this from the 8.1.0 milestone Oct 12, 2022
@MetRonnie MetRonnie added this to the 8.0.3 milestone Oct 12, 2022
wxtim pushed a commit to wxtim/cylc-doc that referenced this issue Oct 31, 2022
* Retire "task job" as a user-facing term in favour of the canonical
  "task" and "job" terms.
* Closes cylc#352
* The ID structure is `workflow//cycle/task/job`, they are tasks and
  jobs not "task-jobs" or "cycle-tasks" or "workflow-cycles".
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation small
Projects
None yet
3 participants