updating-documentation.md

Updating Documentation

Our documentation uses GitBook, and all the Markdown files are stored in our Github repository.

Modify on GitHub

1. Start by forking the repository.

2. Clone the fork on your workstation:

   git clone [email protected]:{YOUR_USERNAME}/airbyte.git
   cd airbyte

3. Modify the documentation.

All our docs are stored in the docs directory. You can use other files as example.

If you're adding new files, don't forget to update docs/SUMMARY.md.

Once you're satisfied with your changes just follow the regular PR process.

For Airbyte's team

To update with GitBook, follow these instructions:

1. Create a new variant. This will create a new branch on GitHub with the same name.
2. Modify the documentation, as you see fit on all pages, in that new variant.
3. Save & merge regularly. Each time you merge, your changes will propagate to your branch. It can take a couple minutes for the changes to show up in GitHub.
4. Once you're satisfied, go on GitHub and create a PR for your variant branch.
5. After the PR is approved, your changes will be merged to master.
6. Don't forget to remove the branch and the variant once your change has been merged.

Just contact us and we will invite you to our space.