Clean up and organize list of commonly used CLI features in cli-usage.md #543
Conversation
DrCord
changed the title
There was a problem hiding this comment.
Couple of discussion points on this one I think @DrCord. I agree with the problems you've identified - just not sold on the solutions in this case!
| @@ -4,10 +4,15 @@ sidebar_label: Basic usage | |||
| slug: /cli-usage | |||
| --- | |||
|
|
|||
| This page shows common usage examples for the CLI. | |||
| This page shows examples for some of the most common usages of the CLI, such as: | |||
There was a problem hiding this comment.
Yes, this is an improvement for sure. Can we maybe say including: instead of such as:?
To be fair this stuff is also in the side nav menu, so I wouldn't be against removing this whole intro paragraph 🤷 It's not adding much is it?
| To run a single job, you must explicitly specify which adaptor to use. You can | ||
| find the list of publicly available [adaptors here](/adaptors). See examples | ||
| below. | ||
| To run a single job, you must explicitly specify which adaptor to use. |
There was a problem hiding this comment.
Can I suggest we remove see examples below and have a less terse link?
Maybe this:
To run a single job, you must explicitly specify which adaptor to use - see the [publicly available adaptors](/adaptors).
| @@ -173,8 +177,8 @@ openfn repo clean | |||
|
|
|||
| ### Run a workflow | |||
|
|
|||
| <details> | |||
| <summary>A workflow has a structure like this</summary> | |||
| <details open> | |||
There was a problem hiding this comment.
hmm. I take your point but I'd probably rather hide the workflow json, it's a bit big. I can't even remember why we're including it.
Can we instead rename the summary text to Click to see a workflow's JSON structure or something?
Clean up and organize list of commonly used CLI features. Clarify link, remove "here" as best practice for linking online.