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.

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

Merged
merged 4 commits into from
Jun 6, 2024
Merged

Cheat sheet #734

merged 4 commits into from
Jun 6, 2024

Conversation

oliver-sanders
Copy link
Member

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.

  • Add a cheat sheet.
  • Move the user-guide "compound commands" section in with "installing workflows" to de-clutter the top-level menu (also a more appropriate home).
  • Move the "troubleshooting" section into the user guide.
  • Re-fiddle the user-guide section order so that the new stuff goes at the end for more logical reading order.

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 May 29, 2024
@oliver-sanders oliver-sanders added this to the 8.3.0 milestone May 29, 2024
@oliver-sanders oliver-sanders self-assigned this May 29, 2024
@wxtim wxtim self-requested a review June 3, 2024 08:21
Copy link
Member

@wxtim wxtim left a 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.

Copy link
Member

@wxtim wxtim left a comment

Choose a reason for hiding this comment

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

Re-checked. 😄

@MetRonnie
Copy link
Member

Is the build failure waiting on a corresponding cylc-flow PR?

@oliver-sanders
Copy link
Member Author

oliver-sanders commented Jun 5, 2024

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/7-to-8/major-changes/cli.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
Install and start a workflow::

# validate a workflow
cylc validate <name/path>
Copy link
Member

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>

Suggested change
cylc validate <name/path>
cylc validate <name|path>

src/user-guide/installing-workflows.rst Outdated Show resolved Hide resolved
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.

Great, couple of small comments.

src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
src/user-guide/cheat-sheet.rst Outdated Show resolved Hide resolved
Co-authored-by: Ronnie Dutta <61982285+MetRonnie@users.noreply.github.com>
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
@MetRonnie MetRonnie merged commit b1e430b into cylc:master Jun 6, 2024
1 check failed
@oliver-sanders oliver-sanders deleted the cheat-sheet branch June 6, 2024 09:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Addition or modification of documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs/site: add "cheat sheet" overview(s) e.g. for CLI
4 participants