GitHub

Cartara integrates with GitHub to scan your repositories for generating and updating documentation, or to create pull requests that create/update README files or other documents.

Connecting to GitHub

1. In the left-hand menu, click the Integrations navigation button.
2. In the top-right toolbar, click the Add GitHub Integration icon.




3. You’ll be redirected to GitHub to install the Cartara App. There, you can select which repositories Cartara is allowed to access.




4. Once connected, the integration will appear in your table. You can edit or delete it at any time by clicking the chevron icon.

Repository Scan

With your GitHub integration connected, you can now access the Repository Sync from the left navigation. Your integration will appear in the list, where you can select and scan your repositories.

Syncing your documents to GitHub

1. Navigate to the document you want to sync. In the top-right toolbar, click the ellipsis (⋯) and select Integrations.




2. Your GitHub integration will appear in the grid view. Click the Connect button to link your document to your GitHub instance.




3. A modal will appear prompting for the following fields:
   • Repository: the repository the document will be sent to
   • Target Branch: The branch where your PR will be created. Defaults to main.
   • File Name: The name your page will have in your GitLab repository. Defaults to README.md




4. Once all required fields are filled out, click Save to connect.
5. Once your document is connected, you must click the Resync button in the bottom-right corner to create or update GitHub pages. This ensures that any edits, additions, or formatting changes in your Cartara document are reflected in GitHub. Resyncing will create a new pull request if one is not alreay there.




6. To edit or delete a document integration, click the ellipsis (⋯) icon to access the available options.
7. That’s it! Your document is now viewable in your GitHub repository.