-
Notifications
You must be signed in to change notification settings - Fork 19
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
Cheat sheet #734
Cheat sheet #734
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.
Seems good. I've made a couple of suggestions, but approved.
cf93daa
to
e9196b0
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.
Re-checked. 😄
Is the build failure waiting on a corresponding cylc-flow PR? |
The build failures (which have been on master for some time) are fixed on one of Hillary's cylc-doc PRs (terminology stuff / missing references). |
src/user-guide/cheat-sheet.rst
Outdated
Install and start a workflow:: | ||
|
||
# validate a workflow | ||
cylc validate <name/path> |
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.
Consider this to avoid misreading as <name>/<path>
cylc validate <name/path> | |
cylc validate <name|path> |
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.
Great, couple of small comments.
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com> Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
e93546e
to
144b808
Compare
Closes #1 (issue number one 🤣)
We've had a few requests for a "cheat sheet" (including one request for a poster, hmmm).
We actually used to have a cheat sheet in the Rose docs (https://metomi.github.io/rose/2019.01.8/html/cheat-sheet.html) but dropped it with Cylc 8 pending reimplementation that never happened.
Requirements check-list
CONTRIBUTING.md
and added my name as a Code Contributor.