Skip to content

Commit

Permalink
Document how gitbook is kept in sync
Browse files Browse the repository at this point in the history
  • Loading branch information
sherifnada committed Nov 8, 2021
1 parent 3b77d03 commit ef1278a
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/contributing-to-airbyte/updating-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,5 @@ _good context_:
When creating or updating connectors, we spend a lot of time manually transcribing JSON Schema files based on OpenAPI docs. This is ncessary because OpenAPI and JSON schema are very similar but not perfectly compatible. This process is automatable. Therefore we should create a program which converts from OpenAPI to JSONSchema format.
```

### How docs are synced with Gitbook
Gitbook tracks the [`gitbook/v1` branch](https://github.com/airbytehq/airbyte/tree/gitbook/v1) from the [Airbyte repository](github.com/airbytehq/airbyte). This branch is synced with master on every push via this [Github action](https://github.com/airbytehq/airbyte/blob/master/.github/workflows/sync-branches.yml).

0 comments on commit ef1278a

Please sign in to comment.