Add more glossary terms #191
Conversation
chu11
force-pushed
the
more_glossary
branch
3 times, most recently
from
d8fc2c0 to
89f2edf
Compare
glossary.rst
Outdated
| Eventlogs are used to record job events, capture standard I/O streams, | ||
| and record resource status changes. | ||
| **Flux Shell** | ||
| A component of Flux which manages the startup and execution of user jobs. You |
There was a problem hiding this comment.
| A component of Flux which manages the startup and execution of user jobs. You | |
| A component of Flux that manages the startup and execution of user jobs. You |
glossary.rst
Outdated
| .. _job_queue: | ||
|
|
||
| **Queue** | ||
| A container for a set of jobs in priority order. Queues may differ in what |
There was a problem hiding this comment.
I think some might read this as "linux container" but I don't think that's what you mean. Is there another term we can use?
There was a problem hiding this comment.
Hmmm. I used "container" b/c that's what we use in the RFC. Doing nothing more than googling "what is a job queue", first description seems to use "data structure", which I don't think is quite right for this context.
Will ponder, perhaps could re-word the whole thing in a different way.
There was a problem hiding this comment.
Maybe something simple and stupid like a list? Or another synonym for queue?
There was a problem hiding this comment.
none of the synonyms spoke to me (vessel, receptacle, ...). As I went for a walk, "data structure" began sounding better to me.
"A scheduling job management data structure that contains sets of jobs in priority order."
There was a problem hiding this comment.
Went for a walk, you say? I have a song for you! https://youtu.be/dZX6Q-Bj_xg
I think data structure sounds ok too, at least I won't confuse it with "those other container things."
glossary.rst
Outdated
| **Queue** | ||
| A container for a set of jobs in priority order. Queues may differ in what | ||
| resources are assigned to them, which users are allowed to submit to them, and | ||
| what defaults/limits may exist for them. Often may be called a "job queue". |
There was a problem hiding this comment.
| what defaults/limits may exist for them. Often may be called a "job queue". | |
| what defaults/limits may exist for them. Often may be called a "job queue." |
glossary.rst
Outdated
| **Queue Enable/Disable/Start/Stop** | ||
| In Flux, the terms "enable"/"disable" are used to describe if jobs can be | ||
| submitted to a queue. The terms "start"/"stop" are used to describe if jobs | ||
| can be executed. Under normal operations, a queue is "enabled"/"started", |
There was a problem hiding this comment.
| can be executed. Under normal operations, a queue is "enabled"/"started", | |
| can be executed. Under normal operations, a queue is "enabled"/"started," |
glossary.rst
Outdated
| submitted to a queue. The terms "start"/"stop" are used to describe if jobs | ||
| can be executed. Under normal operations, a queue is "enabled"/"started", | ||
| which allows users to submit jobs and jobs can run. If a queue is | ||
| "enabled"/"stopped", it means jobs can be submitted but not allowed to run. |
There was a problem hiding this comment.
| "enabled"/"stopped", it means jobs can be submitted but not allowed to run. | |
| "enabled"/"stopped," it means jobs can be submitted but not allowed to run. |
glossary.rst
Outdated
| which allows users to submit jobs and jobs can run. If a queue is | ||
| "enabled"/"stopped", it means jobs can be submitted but not allowed to run. | ||
| This siutation is common if resources are temporarily down for maintenance. | ||
| If a queue is "disabled"/"started", previously submitted jobs can run, but no |
There was a problem hiding this comment.
| If a queue is "disabled"/"started", previously submitted jobs can run, but no | |
| If a queue is "disabled"/"started," previously submitted jobs can run, but no |
https://www.thesaurus.com/e/grammar/does-punctuation-go-inside-or-outside-quotation-marks/
glossary.rst
Outdated
| The | ||
| `Webster's dictionary <https://www.merriam-webster.com/dictionary/workflow>`_ | ||
| definition is "the sequence of steps involved in moving from the beginning to | ||
| the end of a working process". In the context of Flux, this is usually a |
There was a problem hiding this comment.
| the end of a working process". In the context of Flux, this is usually a | |
| the end of a working process." In the context of Flux, this is usually a |
|
re-pushed with fixes / adjustments from comments above |
chu11
force-pushed
the
more_glossary
branch
2 times, most recently
from
8f0b042 to
ae220e2
Compare
Problem: The letter E comes before the letter F! Move the "Eventlog" description higher up.
|
rebased and re-pushed, "sub-instance" -> "subinstance" |
Problem: The glossary does not have enough stuff! Add more.
Some were listed in #186, some weren't. Just trying to fill it out more.