Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added links to docs site
  • Loading branch information
aleksa-krolls authored May 7, 2024
1 parent 4cd7dee commit 7ce7e60
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
<img width="1157" alt="Screenshot 2024-05-07 at 2 45 23 PM" src="https://github.com/OpenFn/project/assets/16758106/aa56f904-06b8-46a9-9ea1-18f973c8b527">


## 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 [email protected] 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 `[email protected]` 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}

0 comments on commit 7ce7e60

Please sign in to comment.