search

cylc / cylc-doc

Documentation (User Guide, Cheat Sheets, etc.) for the Cylc Workflow Engine.
https://cylc.github.io/cylc-doc/
GNU General Public License v3.0
9 stars 19 forks source link

troubleshooting #638

Closed oliver-sanders closed 5 months ago

oliver-sanders commented 1 year ago

The beginnings of a Cylc 8 troubleshooting section, mostly aimed at users as opposed to sys-admins.

This is on an upstream branch, please contribute!

Specific troubleshooting for platform setup issues (sys-admin targetted content) is probably better placed in src/reference/config/writing-platform-configs.rst.

Requirements check-list

oliver-sanders commented 1 year ago

Good.

This is on an upstream branch, please contribute!

Erm, what do you mean by this? Are you suggesting we don't just merge individual PRs to master as usual, to incrementally upgrade the troubleshooting section?

The branch this PR is on is a cylc/cylc-doc branch NOT an oliver-sanders/cylc-doc branch, that means you can push new commits to this PR. I.E. I have intended this PR to be collaborative.

hjoliver commented 1 year ago

The branch this PR is on is a cylc/cylc-doc branch NOT an oliver-sanders/cylc-doc branch, that means you can push new commits to this PR. I.E. I have intended this PR to be collaborative.

Roger that (well, I think we tend to allow pushes to each other's branch too, but I guess a central branch is more clearly for that purpose).

oliver-sanders commented 9 months ago

Should add "Disk IO Error" (ran out of disk space)

oliver-sanders commented 9 months ago

Addressed feedback, fleshed this out a bit.

I think there's enough here to make it worthwhile merging this now so changed the milestone.

oliver-sanders commented 8 months ago

(rebased)

oliver-sanders commented 8 months ago

For the record my other thoughts were:

Did your script fail because you needed to chmod?

Good idea.

log/config/flow-processed.cylc shows you the effect of Jinja2 templating.

Good idea, we could do with a general Jinja2 debugging section including cylc view -p and flow-processed.cylc.

log/config/01-start-01.cylc shows you the effect of Jinja2 and task parameter expansions.

I'm not sure we expand task params, or maybe just in runtime? Can't remember. Good to raise awareness of the config log directory, explain the file numbers and names and why they are useful.

wxtim commented 8 months ago

I'm not sure we expand task params, or maybe just in runtime?

I wasn't sure, so I checked - you're right, it's just the runtime.

image

hjoliver commented 5 months ago

@wxtim - do you want to (or have you) posted another issue for your additional points above? https://github.com/cylc/cylc-doc/pull/638#pullrequestreview-1851388590

wxtim commented 5 months ago

@wxtim - do you want to (or have you) posted another issue for your additional points above? #638 (review)

It's #725

oliver-sanders commented 5 months ago

Comments addressed bar a couple.