Skip to content

Commit 003cb63

Browse files
committed
fiddling with sync
1 parent ce39e8c commit 003cb63

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

docs/manage-projects/link-to-gh.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
---
2-
title: Version Control
3-
sidebar_label: Version Control (GitHub Sync)
2+
title: GitHub Sync
3+
sidebar_label: GitHub Sync
44
slug: /link-to-GitHub
55
---
66

7-
The version control (GitHub Sync) feature lets users track and manage changes to
8-
their OpenFn projects in GitHub. GitHub Sync enables a 2-way sync between your
9-
OpenFn project and your GitHub repository. By 2-way sync, we mean that you can
10-
**sync changes made to your project on OpenFn to GitHub**, and you can **deploy
11-
changes you've made to your project on GitHub to OpenFn**.
7+
GitHub Sync enables two-way sync between OpenFn project and your GitHub
8+
repository.
9+
10+
This means changes made to a Project in OpenFn can commit back to your GitHub
11+
repo; and commits pushed to GitHub can update the Project in your OpenFn App.
1212

1313
:::info For Cloud Hosted OpenFn Users
1414

1515
GitHub Sync is only available in projects that are subscribed to Core, Growth,
16-
Scale or Custom plans on Cloud Hosted OpenFn. Users can however connect their
17-
OpenFn account to GitHub by authenticating OpenFn to access their GitHub account
18-
by navigating to `User Profile` page and clicking ` Connect your GitHub
19-
Account".
16+
Scale or Custom plans on Cloud Hosted OpenFn.
17+
18+
Users can however connect their OpenFn account to GitHub by authenticating
19+
OpenFn to access their GitHub account by navigating to `User Profile` page and
20+
clicking ` Connect your GitHub Account".
2021

2122
:::
2223

23-
### Configuring your project to use GitHub Sync
24+
### Configuring your Project to use GitHub Sync
2425

25-
Users are able to configure their projects to have access to one or more
26-
repositories on GitHub. To enable sync, the OpenFn project requires a repository
27-
where a GitHub OpenFn application is installed and users are required to have
28-
administrative access to the repositiory.
26+
Users can configure their projects to access one or more repositories on GitHub.
27+
Users must have admin access to the GitHub Repo to ensure the OpenFn application
28+
is installed.
2929

3030
To configure your project to use Github sync, follow the following steps:
3131

@@ -285,8 +285,6 @@ your-git-monorepo
285285

286286
:::tip A sync in time, saves nine
287287

288-
#### Syncing Changes from OpenFn to GitHub
289-
290288
When you sync changes from OpenFn to GitHub, the `projectSpec.yaml` file in your
291289
repository will be updated with the changes made to the project in OpenFn. For a
292290
project with a directory structure that uses relative paths for job code, OpenFn
@@ -298,7 +296,9 @@ When you keep job code in relative file paths, ensure to update the
298296
`projectSpec.yaml` file based on changes to the files or paths in your project
299297
repository. A GitHub action is automatically triggered to push changes to OpenFn
300298
ensuring that future syncs are not affected. Changes can include adding,
301-
renaming, deleting a file or updating a file path. :::
299+
renaming, deleting a file or updating a file path.
300+
301+
:::
302302

303303
## Troubleshooting
304304

0 commit comments

Comments
 (0)