OpenFn / OpenFn/lightning

Add adaptor tags to show quality and support

Open
#3,036 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 developer experience by indicating the level of support and quality of adaptors

KPI: Consultant NPS

When building workflows, developers do not know the level of support an adaptor gets from the core team and/or community. A poorly maintained adaptor might affect a workflow's scalability and require a workflow redesign in the future to support new use cases which might be frustrating for them.

Solution Concepts:
Give adaptors a tag: Core, New, Outdated [TBD], and add the tags to the [package.json?] for each adaptor.
On Lightning:
We want to nicely render the tags on the canvas under each job and also in the docs panel on the editor.

Image

In the future, we would love to render the information on the adaptor docs overview and functions page.

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 locating the adaptor package.json files and the Lightning canvas and editor docs-panel entry points. Clarify the final tag set and ownership rules, then define completion as tags being stored for each adaptor and rendered under jobs and in the editor docs panel; the future overview and functions-page work is explicitly later.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
developer-experience, full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.