Improve Job Script Environment Variables reference #853
Conversation
jfrost-mo
force-pushed
the
job_script_environment_variables
branch
from
f12e0ae to
50b2694
Compare
This make better use of the semantics of HTML, and should also be more accessible. It also avoid this issue of longer lines of description causing a scrollbar to appear that was noted in cylc#853.
|
I realise I forgot to copy the second commit message into the PR description. The first commit adds a number of missing variables and improves descriptions, while the second changes the formatting to use a HTML definition lists. (Mostly because it is one of my favourite HTML elements currently.) Would you like me to convert this to use the envvar domain? |
Not now, this is enough of an improvement as it is. I'll leave that issue open. |
jfrost-mo
force-pushed
the
job_script_environment_variables
branch
from
e281d3b to
6b2422c
Compare
|
The "check contributor list" test failure is not related to this PR. |
|
But the test failure is related :( We have a (very annoying) spellchecker which fails everything! Words can be added globally here: https://github.com/cylc/cylc-doc/tree/master/src/dictionaries Or locally (to a particular file) using a directive: cylc-doc/src/tutorial/runtime/runtime-configuration.rst Lines 493 to 495 in 25acd23 Use |
jfrost-mo
force-pushed
the
job_script_environment_variables
branch
from
f37b095 to
c2474b5
Compare
|
Spelling fixed in c2474b5. |
jfrost-mo
force-pushed
the
job_script_environment_variables
branch
from
c2474b5 to
714654f
Compare
The variable CYLC_WORKFLOW_LOG_DIR was newly added, and existing variables had their descriptions and examples improved, notably adding the run sub-directory to the example paths. Variables have also been slightly reordered to be more logically grouped. The longer name for CYLC_TASK_LOG_ROOT does however make a scrollbar appear, which may be undesirable. Fixes: cylc#779 Signed-off-by: James Frost <[email protected]>
This make better use of the semantics of HTML, and should also be more accessible. It also avoid this issue of longer lines of description causing a scrollbar to appear.
jfrost-mo
force-pushed
the
job_script_environment_variables
branch
from
714654f to
9ff59d2
Compare
|
Rebased to fix conflict. (And add gregorian to non-proper nouns, due to how we are using it.) |
|
Looks like the failure is just a transient linkcheck issue. Rerunning should fix it. |
The variables
CYLC_ENV_NAMEandCYLC_WORKFLOW_LOG_DIRwere newly added, and existing variables had their descriptions and examples improved, notably adding the run sub-directory to the example paths.The longer name for
CYLC_TASK_LOG_ROOTdoes however make a scrollbar appear. To counter this, and also to make better use of the semantics of HTML, I've then converted this reference to a definitions list. This should be more accessible, easier to copy from, and IMO is easier to read.Rendered version: https://tmpweb.net/V5cucaJ-1HKF/reference/job-script-vars/
Fixes: #779
Requirements check-list
CONTRIBUTING.mdand added my name as a Code Contributor.