-
Notifications
You must be signed in to change notification settings - Fork 191
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.
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
Docs: Add verdi process status
command to tutorial
#4508
Docs: Add verdi process status
command to tutorial
#4508
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @mbercx . Have two comments
e886ed1
to
5102be4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @mbercx - looks good to me.
don't know whether you want to wait for more input before merging
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All good for me. I was just wondering if we should add that it is recursive, meaning that if one of the called processes itself also calls subprocesses, those will also be shown recursively. This might not be obvious since the example only has a single level
I think it's ok to leave it as it is. As you said, the example doesn't demonstrate the recursion, and I think it will be clear if they use this command on a work chain where one of the processes also calls subprocesses. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go
Co-authored-by: Leopold Talirz <leopold.talirz@gmail.com>
5f3469f
to
a4b71a2
Compare
Had to rebase to |
If the commits of the PR will be squashed anyway, then this is not necessary. You can simply use the "Update branch" button of Github to merge |
Right, we weren't running all the checks for the documentation PR's. How do I get GitHub to run all the checks so I can merge the PR? |
We cannot, because the checks re explicitly skipped, so we can only merge with admin rights, bypassing the checks. This is not ideal. If you could look, maybe with @chrisjsewell , how the skipping can be done within the action, such that it still runs, but it just shortcuts if the unit tests don't actually have to run. This would be the better solution, because then the PRs will also not show up as "still running" with the yellow circle but will get the green checkmark |
Fixes #4505
Currently the
verdi process status
command is only mentioned once in the documentation (in topics/processes/usage ). Since this command is both useful for getting a nice succinct overview of a work chain and debugging, it deserves a mention in the basic tutorial.This PR adds the command just before generating the final provenance graph.