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

Refresh CLI pages #377

Merged
merged 14 commits into from
Jan 4, 2024
Merged

Refresh CLI pages #377

merged 14 commits into from
Jan 4, 2024

Conversation

mtuchi
Copy link
Contributor

@mtuchi mtuchi commented Dec 13, 2023

Short Description

Update CLI Challenge and Basic Usage.

Ref #375 , #361 , #368

Implementation Checklist

  • Intro to the OpenFn CLI (see docs/build-for-developers/cli-intro.md)
  • CLI Installation & Usage (see docs/build-for-developers/cli-usage.md)
  • Testing workflows with the CLI (NEW page to add? Or does this content already exist somewhere?)
  • CLI Tutorial (see docs/build-for-developers/cli-tutorial.md)
  • Remove strict mode
  • Fix examples in CLI tutorial
  • Get started video

@mtuchi mtuchi linked an issue Dec 13, 2023 that may be closed by this pull request
4 tasks
@mtuchi mtuchi marked this pull request as ready for review December 13, 2023 09:04
@mtuchi mtuchi marked this pull request as draft December 13, 2023 09:05
@mtuchi mtuchi marked this pull request as ready for review December 14, 2023 09:08
@mtuchi mtuchi marked this pull request as draft December 14, 2023 09:13
docs/build-for-developers/cli-installation.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-installation.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-tutorial.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-tutorial.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-usage.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-usage.md Outdated Show resolved Hide resolved
docs/build-for-developers/cli-usage.md Outdated Show resolved Hide resolved
To run a workflow

```bash
openfn path/to/workflow.json -i
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe it's time we autoinstall by default eh? Makes a lot of our documentation simpler

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@josephjclark I was think the same thing but for local development a user must at-least setup their repo for local installation of adaptors. Then if i ran a job and forgotten -i it will check in the repo first then decide if we should download or not.

It's a good developer experience but i think it might be a lot of work for cli

@mtuchi mtuchi requested a review from daissatou2 December 14, 2023 12:28
@mtuchi mtuchi marked this pull request as ready for review December 14, 2023 12:28
Copy link
Contributor

@daissatou2 daissatou2 left a comment

Choose a reason for hiding this comment

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

@mtuchi I've left comments for your review. Please also consider the following:

  1. The tutorial page is very long. Can we add a table of contents at the top of the page which links to the different sections?
  2. I think we should remove any reference to an "administrator" on the tutorial page and encourage folks to post on Community instead.
  3. Section 8 of the tutorial references “flow trigger pattern”. Can you update this to use V2 language?

@daissatou2
Copy link
Contributor

@NickOpenFn would love your feedback on these CLI docs pages!

@mtuchi
Copy link
Contributor Author

mtuchi commented Dec 18, 2023

@daissatou2 there is a table of content on the right side of the page, See screenshot 👇🏽. And to reduce the content for tutorial i have separated Walkthrough and Challenges to their own page

Screenshot 2023-12-18 at 3 45 58 PM

@mtuchi mtuchi requested a review from aleksa-krolls December 19, 2023 12:05
@mtuchi
Copy link
Contributor Author

mtuchi commented Dec 19, 2023

@aleksa-krolls this is ready for review, you can see the section that needs to be update here cli-walkthrough#7-running-workflows Specifically this section 👇🏽

For example, if you have two jobs in your workflow (GET users from system A & POST users to system B), you can set up your workflow to run all jobs in sequence from start to finish. This imitates the flow trigger patterns on the OpenFn platform where a second job should run after the first one succeeds, respectively, using the data returned from the first job. “

@aleksa-krolls aleksa-krolls merged commit 62a2e3f into main Jan 4, 2024
1 check passed
@mtuchi mtuchi deleted the 375-refresh-cli-pages branch February 12, 2024 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

v2 lightning docs: refresh CLI pages
4 participants