diff --git a/docs/manage-projects/link-to-gh.md b/docs/manage-projects/link-to-gh.md index 1e046475511..79999e2f815 100644 --- a/docs/manage-projects/link-to-gh.md +++ b/docs/manage-projects/link-to-gh.md @@ -36,19 +36,41 @@ Click `Configure`... 5. You'll be redirected to OpenFn. Select the repository and branch you want to sync to, and click `Connect Branch`. -6. Your GitHub connection is now set up! From here, each time you want to sync - between your project and GitHub, click `Initiate Sycn to Branch`. +6. Your GitHub connection is now set up! + +7. Synchronization is _not_ automatic. Each time you want to sync between your + project and GitHub, click `Initiate Sync to Branch`. + +![Initiate Sync](/img/lightning_gh_initate_sync.png) + +:::tip Sync after every major change + +Each time you make any significant change in your project, for example changes +in a job code, make sure to hit `Initiate Sync to Branch` to sync your updates +to GitHub. + +::: ### How It Works in a Nutshell -Your whole OpenFn project can be represented as a project.yaml file. +Your whole OpenFn project can be represented as a `project.yaml` file. It +includes all your workflow specifications, their name, job code, triggers, and +so on. -Using our Command Line Interface, the -[@openfn/cli](../deploy/portability.md) +Using our Command Line Interface, the [@openfn/cli](../deploy/portability.md) you can pull a project config from OpenFn to a folder or repo on your computer, -and you can deploy a change in your project.yaml file from that directory or +and you can deploy a change in your `project.yaml` file from that directory or repo to OpenFn. +:::info + +As your `project.yaml` file represents your entire project, this is the file +that you have to update when you want to deploy any changes to your OpenFn +project. If you made a change or created a new job, for example, you have to +include them in the `project.yaml` to deploy. + +::: + The `Sync to Github` feature makes use of GitHub actions to automatically deploy (after a commit) or pull (when `Initiate Sync to Branch` button is clicked) to keep a repository in sync with your OpenFn project. diff --git a/static/img/lightning_gh_initate_sync.png b/static/img/lightning_gh_initate_sync.png new file mode 100644 index 00000000000..3b697f8ae81 Binary files /dev/null and b/static/img/lightning_gh_initate_sync.png differ