-
Notifications
You must be signed in to change notification settings - Fork 14
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
Refresh CLI
pages
#377
Conversation
To run a workflow | ||
|
||
```bash | ||
openfn path/to/workflow.json -i |
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.
Maybe it's time we autoinstall by default eh? Makes a lot of our documentation simpler
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.
@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
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.
@mtuchi I've left comments for your review. Please also consider the following:
- 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?
- I think we should remove any reference to an "administrator" on the tutorial page and encourage folks to post on Community instead.
- Section 8 of the tutorial references “flow trigger pattern”. Can you update this to use V2 language?
@NickOpenFn would love your feedback on these CLI docs pages! |
@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 |
@aleksa-krolls this is ready for review, you can see the section that needs to be update here
|
Short Description
Update CLI Challenge and Basic Usage.
Ref #375 , #361 , #368
Implementation Checklist
docs/build-for-developers/cli-intro.md
)docs/build-for-developers/cli-usage.md
)docs/build-for-developers/cli-tutorial.md
)