OpenFn / OpenFn/lightning

Import (and clone) projects

Open
#2,955 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

Goal:

Improve user onboarding by enabling users to import a project.yaml file to create or update their project.

KPI: Improve consultant NPS
Problem/Observation:

Currently, we allow users to export their project as a project.yaml, but they cannot easily import projects into OpenFn via a user interface. The current work around for this is via the CLI deploy path.

Allowing users to bootstrap projects by importing a project.yaml will make the building and getting started experience faster, especially if the user has a template project they want to replicate.

Assumptions:
  • #2956 has a higher priority and gets us closer to templates than importing projects.
Constraints:
  • Importing projects on TB will require billing and consideration for plan usage limits.
What to be done:
  • #3020
  • #3021

In the future, we want to be able to support the following:

  • #3022
  • #3023

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the project.yaml export and CLI deploy paths, then review subissues #3020 and #3021 to understand the planned scope. Done means the user interface can import a project.yaml to create or update a project, with billing and plan limits considered for TB.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.