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.

Sign up for GitHub

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

Jump to bottom

troubleshooting #638

Merged
merged 4 commits into from
May 1, 2024
Merged

troubleshooting #638

merged 4 commits into from
May 1, 2024

Conversation

oliver-sanders
Copy link
Member

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

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.

@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Aug 29, 2023
@oliver-sanders oliver-sanders added this to the pending milestone Aug 29, 2023
hjoliver
hjoliver reviewed Sep 3, 2023
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
@oliver-sanders
Copy link
Member Author

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
Copy link
Member

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
Copy link
Member Author

oliver-sanders commented Dec 19, 2023 •
edited
Loading

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

  • Done.

@oliver-sanders oliver-sanders modified the milestones: pending, 8.3.0 Dec 20, 2023
@oliver-sanders
Copy link
Member Author

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
Copy link
Member Author

(rebased)

wxtim
wxtim approved these changes Jan 30, 2024
View reviewed changes
Copy link
Member

@wxtim wxtim left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. I was going to add a couple of things, but it might be better to get it in then I'll propose those additions.

For the record my other thoughts were:

  • Did your script fail because you needed to chmod?
  • log/config/flow-processed.cylc shows you the effect of Jinja2 templating.
  • log/config/01-start-01.cylc shows you the effect of Jinja2 and task parameter expansions.

@oliver-sanders
Copy link
Member Author

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
Copy link
Member

wxtim commented Jan 30, 2024 •
edited
Loading

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 hjoliver mentioned this pull request Mar 12, 2024
Closed
hjoliver
hjoliver requested changes Apr 30, 2024
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely need this in 8.3.0

src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Outdated Show resolved Hide resolved
src/troubleshooting.rst Show resolved Hide resolved
@hjoliver
Copy link
Member

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

@wxtim wxtim mentioned this pull request Apr 30, 2024
Open
@wxtim
Copy link
Member

wxtim commented Apr 30, 2024

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

It's #725

@oliver-sanders oliver-sanders mentioned this pull request Apr 30, 2024
Open
9 tasks
@oliver-sanders
Copy link
Member Author

Comments addressed bar a couple.

hjoliver
hjoliver reviewed Apr 30, 2024
View reviewed changes
src/troubleshooting.rst Outdated Show resolved Hide resolved
@oliver-sanders @hjoliver
Apply suggestions from code review
cffc0e8 
Co-authored-by: Hilary James Oliver <[email protected]>
@oliver-sanders oliver-sanders requested a review from hjoliver May 1, 2024 08:23
@hjoliver hjoliver merged commit be4cbd7 into master May 1, 2024
1 check failed
@hjoliver hjoliver deleted the troubleshooting branch May 1, 2024 21:38
@oliver-sanders oliver-sanders mentioned this pull request May 29, 2024
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wxtim wxtim wxtim approved these changes

@hjoliver hjoliver hjoliver approved these changes

Assignees
No one assigned
Labels
content Addition or modification of documentation
Projects
None yet
Milestone
8.3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@oliver-sanders @hjoliver @wxtim