diff --git a/README.md b/README.md index 8dbf297..506e935 100644 --- a/README.md +++ b/README.md @@ -3,23 +3,37 @@ 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.org. Always work on a branch!* +*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 +See the [OpenFn CLI docs](https://docs.openfn.org/documentation/cli-walkthrough#7-running-workflows) for more on writing, running, and testing workflows locally. +See the [Platform Docs](https://docs.openfn.org/documentation/build/steps/step-editor) for how to run and test workflows on the app. + +## Project Documentation +The OpenFn team will often leverage [Github Pages](https://pages.github.com/) 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/](https://openfn.github.io/project/) + +Github Page configuration can be adjusted in the `Settings` of this repository. +Screenshot 2024-05-07 at 2 45 23 PM + + ## Implementation Checklist -[See this workbook](https://docs.google.com/spreadsheets/d/1_XY0nx0OLNUsogrIHnRaSTyZ-KdcSXks-tqwm3ZfMc4/edit#gid=72612093) for a template work plan for the OpenFn implementation, or contact support@openfn.org to get the Asana-version of this checklist. +[See OpenFn Docs site](https://docs.openfn.org/documentation/get-started/implementation-checklist) or [this workbook](https://docs.google.com/spreadsheets/d/1_XY0nx0OLNUsogrIHnRaSTyZ-KdcSXks-tqwm3ZfMc4/edit#gid=72612093) 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 -- Maintenance: Team responsible for software maintenance, security updates, etc. - confirm roles & responsibilities across systems +- 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} +- {Contact1 name, email}