project

project-name

Please update this readme when you start a new project. Summarize the solutions implemented or leverage Github pages to build a documentation site.

Note that commits to main will be auto-deployed to OpenFn app if the Github Sync is enabled. Always work on a branch!

Getting started with the Repo

1. create /tmp folder locally with a state.json file that you don’t commit to github
2. start writing and testing jobs locally with the relevant adaptor

Getting Help

To learn more about writing job code, see writing-jobs.md

See the OpenFn CLI docs for more on writing, running, and testing workflows locally.

See the Platform Docs for how to run and test workflows on the app.

Project Documentation

The OpenFn team will often leverage Github Pages to configure a documentation site to organize and display project-specific information. This site can display the content on this README, or be pointed to another markdown .md file created on this repo specifically for docs.

See this example Github pages site that displays this README as a simple site: https://openfn.github.io/project/

Github Page configuration can be adjusted in the Settings of this repository.

Implementation Checklist

See OpenFn Docs site or this workbook for a template work plan for the OpenFn implementation, or contact support@openfn.org to get the Asana-version of this checklist.

Administration

It’s good practice to document on the read me who is responsible for managing & maintaining the OpenFn project.

Provisioning, Hosting, & Maintenance

Document details specific to your OpenFn deployment

• Deployment: SaaS or Local?
• Platform Version: OpenFn V1 or V2
• Maintenance: Specify the team responsible for software maintenance, security updates, etc. - confirm roles & responsibilities across systems

Support

List relevant support point of contacts and system administrators.

• {Contact1 name, email}