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: Notes on Jinja2 and Startup config logs #735

Merged
merged 15 commits into from
Jul 16, 2024
Merged

Troubleshooting: Notes on Jinja2 and Startup config logs #735

merged 15 commits into from
Jul 16, 2024

Conversation

wxtim
Copy link
Member

@wxtim wxtim commented May 31, 2024

Closes #725

  • Failure to make scripts executable is common task failure cause.
  • How to inspect the results of Jinja2 Templating.
  • How to inspect the config at each startup..

Requirements check-list

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

@wxtim wxtim added the content Addition or modification of documentation label May 31, 2024
@wxtim wxtim added this to the 8.3.x milestone May 31, 2024
@wxtim wxtim requested a review from oliver-sanders May 31, 2024 08:23
@wxtim wxtim self-assigned this May 31, 2024
oliver-sanders
oliver-sanders reviewed Jun 5, 2024
View reviewed changes
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
@oliver-sanders
Copy link
Member

Note the troubleshooting page is moving in #734 (but otherwise staying the same)

wxtim
wxtim commented Jun 6, 2024
View reviewed changes
src/troubleshooting.rst Outdated Show resolved Hide resolved
@wxtim wxtim requested a review from hjoliver June 6, 2024 09:43
wxtim added 3 commits June 6, 2024 10:48
@wxtim
remove reference to Cylc val having line numbers
f2efd2d
@wxtim
Merge branch 'content.troubleshooting' of github.com:wxtim/cylc-doc i…
fa4a074 
…nto content.troubleshooting

* 'content.troubleshooting' of github.com:wxtim/cylc-doc:
  Update src/troubleshooting.rst
@wxtim
Merge remote-tracking branch 'upstream/master' into content.troublesh…
d42718c 
…ooting

* upstream/master:
  Revert "Deply to wxtim docs"
  Apply suggestions from code review
  user guide: move troubleshooting into user guide
  user guide: move "compound commands" in with "installing workflows"
  user guide: add cheat sheet
@wxtim wxtim requested a review from oliver-sanders June 6, 2024 10:19
hjoliver
hjoliver reviewed Jun 11, 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.

Good, couple of minor corrections.

src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
wxtim and others added 2 commits June 12, 2024 09:00
@wxtim wxtim requested a review from hjoliver June 12, 2024 08:00
@wxtim wxtim removed the request for review from hjoliver June 24, 2024 12:00
@wxtim wxtim requested a review from MetRonnie June 24, 2024 12:00
@oliver-sanders oliver-sanders changed the base branch from master to 8.3.x June 27, 2024 15:08
MetRonnie
MetRonnie reviewed Jul 10, 2024
View reviewed changes
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
src/user-guide/troubleshooting.rst Outdated Show resolved Hide resolved
@wxtim wxtim requested a review from MetRonnie July 12, 2024 10:07
MetRonnie
MetRonnie requested changes Jul 12, 2024
View reviewed changes
Copy link
Member

@MetRonnie MetRonnie left a comment

Choose a reason for hiding this comment

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

Approval pending spelling fixes

@MetRonnie
Copy link
Member

Hmm, wot's all this then?

WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.auto_restart' with 'auto_restart'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.health_check' with 'health_check'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.log_data_store' with 'log_data_store'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.log_main_loop' with 'log_main_loop'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.log_memory' with 'log_memory'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.main_loop.reset_bad_hosts' with 'reset_bad_hosts'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.at' with 'at'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.background' with 'background'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.loadleveler' with 'loadleveler'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.lsf' with 'lsf'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.moab' with 'moab'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.pbs' with 'pbs'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.sge' with 'sge'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.slurm' with 'slurm'.
WARNING: Summarised items should not include the current module. Replace 'cylc.flow.job_runner_handlers.slurm_packjob' with 'slurm_packjob'.

@oliver-sanders
Copy link
Member

Looks like Sphinx is complaining about the way we autodocument modules? I don't think that has anything to do with this PR.

@MetRonnie
Copy link
Member

MetRonnie commented Jul 16, 2024 •
edited
Loading

Ah yeah, the nightly build is failing on the same thing on master. Possibly a new version of Sphinx?

@MetRonnie
Copy link
Member

Kicking tests

@MetRonnie MetRonnie closed this Jul 16, 2024
@MetRonnie MetRonnie reopened this Jul 16, 2024
MetRonnie
MetRonnie approved these changes Jul 16, 2024
View reviewed changes
Copy link
Member

@MetRonnie MetRonnie left a comment

Choose a reason for hiding this comment

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

Just linkcheck failing

@MetRonnie MetRonnie merged commit 59c9f41 into cylc:8.3.x Jul 16, 2024
0 of 2 checks passed
wxtim added a commit to wxtim/cylc-doc that referenced this pull request Oct 4, 2024
@wxtim
Troubleshooting: Notes on Jinja2 and Startup config logs (cylc#735)
7623989
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver left review comments

@MetRonnie MetRonnie MetRonnie approved these changes

@oliver-sanders oliver-sanders oliver-sanders approved these changes

Assignees

@wxtim wxtim

Labels
content Addition or modification of documentation
Projects
None yet
Milestone
8.3.x
Development

Successfully merging this pull request may close these issues.

Troubleshooting Guide: Additional things to say
4 participants
@wxtim @oliver-sanders @MetRonnie @hjoliver