Contribute to Matillion's docs using GitHub

Use this guide to learn how to contribute changes to Matillion's documentation using only GitHub.

---

Prerequisites

• You'll need a GitHub account.
• You'll need access to the matillion-docs GitHub repo.

---

How to contribute

1. Visit the matillion-docs repo.
2. Click Branches. There will be a number representing the current number of active branches. Don't worry about the number.
3. Click the green New branch button.

4. Name your branch. Ensure the source branch is main and then click the green Create new branch button.

   

5. Your branch will now be added to the branch list. You should see it in the Your branches menu, but you can also search for the branch.

6. Click on your branch.
7. Click into the Go to file search bar and type in the name of the file you want to edit.
   • Files are all lowercase, with words separated by hyphens (kebab case).
   • Files end in .md because they are Markdown files.
   • Use the URL from the docs site to help you locate the file. For example, for https://docs.matillion.com/data-productivity-cloud/hub/docs/edit-user-permissions/ the file name is edit-user-permissions.md.
8. Click on the correct search result.
9. This will take you into the file. In the top-right, click the pencil icon to edit the file.
10. Carefully edit the Markdown. Use our style guide where necessary.
11. Once you make your changes, click the green Commit changes button.

12. A dialog will open where you can add a commit message. Click the green Commit changes button again.

    

13. Go to the Pull requests tab, which you can also find here: pull requests.

14. From here, you have two options:
    1. Click Compare and pull request in the banner if you are making a pull request soon after pushing your commits.
    2. If you don't see a yellow banner, click New pull request and select your branch, and then click the green Create pull request button.
15. Fill out the pull request summary. Try to provide clear detail and rationale for your changes. Ensure the base branch is main unless you know you want to merge into a branch that isn't main. Click the green Create pull request button.
16. The documentation team and any other stakeholders will review your pull request.
17. If you receive any comments with suggested changes, reuse this guide to edit the file again.
18. Once the pull request has been approved, click Squash and merge followed by Confirm squash and merge.
19. Upon a merge to main, a CI/CD pipeline activates, and your changes will be deployed to docs.matillion.com in a few minutes.