search

OpenFn / adaptors

The new home for OpenFn adaptors; re-usable connectors for the most common DPGs and DPI building blocks.
GNU General Public License v3.0
7 stars 8 forks source link

docs on how to use the adaptor "template" to create your own adaptor #774

Open aleksa-krolls opened 4 days ago

aleksa-krolls commented 4 days ago

We want to start engaging more developers outside of OpenFn to build adaptors... will be a nice way to grow open source contributions.

I understand that we now have an adaptor "template" for a basic adaptor that handles authentication and supports generic http requests.

Can you please draft some documentation (designed for outside devs who want to build their own adaptors) explaining what this template is and how to use it?

See here for existing docs. Please expand these and/or create a separate docs page dedicated to using the template adaptor (whichever you think is best). Assign the PR to me whenever ready!

josephjclark commented 3 days ago

Aah sorry @aleksa-krolls I said I'd do this and completely forgot :(

The monorepo readme contains a tutorial that Amber (former product manager) wrote, so its well over a year old by now, and many things have changed (including the new generator).

I think we should remove all that and add a really short, simple guide using the template

For the record I really think this stuff should be in the repo wiki https://github.com/OpenFn/adaptors/wiki. We can always link to wiki docs from the readme.

aleksa-krolls commented 3 days ago

@hunterachieng when you start on this, pls note Joe's comment above --> let's add this to the repo wiki