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

Steps docs #390

Merged
merged 17 commits into from
Feb 12, 2024
Merged

Steps docs #390

merged 17 commits into from
Feb 12, 2024

Conversation

mtuchi
Copy link
Contributor

@mtuchi mtuchi commented Feb 2, 2024

Description

Reusing jobs docs for v2. It involves a lot of clean up and refreshing the language to v2

Tasks

  • Introduction to steps
  • Designing a step
  • A closer look at steps
  • What's an operation
  • Using multiple operation
  • The OpenFn Inspector video
  • The initial and final state of the run
  • The each(..) operation
  • Editing steps locally
  • Working with branches

Closes #388

@mtuchi mtuchi changed the title V2 jobs docs refresh Steps docs Feb 5, 2024
@mtuchi mtuchi requested a review from aleksa-krolls February 7, 2024 05:24
@mtuchi mtuchi marked this pull request as ready for review February 8, 2024 09:09
@mtuchi
Copy link
Contributor Author

mtuchi commented Feb 8, 2024

@aleksa-krolls this is a work in progress of the OpenFn Inspector video

@aleksa-krolls
Copy link
Member

aleksa-krolls commented Feb 8, 2024

@mtuchi back to you to review & add the video! Please pull from this branch - I added a bunch of commits.

Also... can you please:

  1. Clean up my broken links? See error detail

  2. Make a quick 2-min video for the steps.md page to describe how to go to Workflow Canvas > create a new Step > and then describe its basic anatomy. In the video, you can say something like: "see the Inspector docs to learn more about this interface and editing the job expression or code associated with this Step."
    step-anatomy

@mtuchi
Copy link
Contributor Author

mtuchi commented Feb 8, 2024

@aleksa-krolls i have cleaned up the broken links, i will work on the video next

@aleksa-krolls aleksa-krolls merged commit ede3809 into main Feb 12, 2024
1 check passed
@aleksa-krolls aleksa-krolls deleted the v2-jobs-docs-refresh branch February 12, 2024 06:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Refresh V1 docs on jobs for V2
2 participants