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

v2 lightning docs: refresh CLI pages #375

Closed
3 of 4 tasks
aleksa-krolls opened this issue Nov 29, 2023 · 0 comments · Fixed by #377
Closed
3 of 4 tasks

v2 lightning docs: refresh CLI pages #375

aleksa-krolls opened this issue Nov 29, 2023 · 0 comments · Fixed by #377
Assignees

Comments

@aleksa-krolls
Copy link
Member

aleksa-krolls commented Nov 29, 2023

Request

In the new v2 docs section Build Workflows - For Developers, we want to add/refresh the following docs pages:

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

I recommend starting with 1 page --> get feedback from me & Nick on the page structure and look --> and then proceed with the rest.

If you have any comments or ideas for new pages, please leave notes in the docs Information Architecture sheet.

For review

Create a new branch off of main and draft a PR with these changes for review. Assign to me when ready for review.

Resources

Before you start work, please review Nick's thoughts on how to write docs.

See the Docs Style Guide for other guidance when writing in markdown.

@mtuchi mtuchi linked a pull request Dec 13, 2023 that will close this issue
7 tasks
@mtuchi mtuchi mentioned this issue Dec 13, 2023
7 tasks
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 a pull request may close this issue.

2 participants