How‐to: Update documentation (via Github)

Contents
Prerequisites
Walkthrough

Prerequisites

1. You've been added as a contributor on the gcds-docs repo.

Walkthrough

STEP 1: Create a branch

• Go to gcds-docs' Branches
• Click New branch button
• Name the branch
• Ensure Source is main

STEP 2: Go to created branch

Under Your branches

• Click the branch you created

STEP 3: Locate component to update

For English documentation

• Go to src ➔ en ➔ components ➔ [component]

For French documentation

• Go to src ➔ fr ➔ composants ➔ [composant]

STEP 4: Make a change

• Open the doc section you want to update (.md file)
• Click button with pencil icon to edit

STEP 5: Commit changes

When finished editing

• Click Commit changes... button
• Input a commit message
• Ensure Commit directly to the [branch] is selected
• Click Commit changes button

STEP 6: Make additional changes (as needed)

Repeat STEP 4 and STEP 5

STEP 7: Submit changes for review

• Click Pull requests navigation tab
• Click Compare & pull request button
• Provide a description of changes
• Under Reviewers, Request a review from a dev (Ethan, Melanie, Daine)
• Review your changes with the Split view
• Finally, click Create pull request button