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

Clean up and organize list of commonly used CLI features in cli-usage.md #543

Merged
merged 2 commits into from
Sep 16, 2024
Merged

Clean up and organize list of commonly used CLI features in cli-usage.md #543

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d17bb1d
Update cli-usage.md
DrCord Aug 23, 2024
e2483d1
resolve feedback re: changes
DrCord Sep 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/build-for-developers/cli-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

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

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?


Execute a job, run a workflow, adjust logging, maintain adaptors, and save the
state.
- get help
- run a job
- saving the state
- adjust logging level
- maintain adaptors repo
- run a workflow
- load adaptor documentation

---

Expand All @@ -25,9 +30,8 @@ openfn deploy --help

### Run a job

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

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).

[Publicly available adaptors](/adaptors). See examples below.

Adaptors are automatically installed if the specified version is not detected.

Expand Down Expand Up @@ -173,8 +177,8 @@ openfn repo clean

### Run a workflow

<details>
<summary>A workflow has a structure like this</summary>
<details open>
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

<summary>A workflow has a structure like this:</summary>

```json
{
Expand Down