How to Edit GYC Volunteer Documentation

This guide provides instructions for editing the GYC volunteer documentation using GitHub.

Step 1: Create a GitHub Account

1. Visit GitHub and create an account.
2. If you already have an account, simply sign in.

Step 2: Obtain Editing Permission

Contact one of the following individuals to request editing permission:

• Caleb Whiting
• Jonathan Jensen (Email: jjensen@gycweb.org)

Step 3: Access the Edit Button

1. Once permission is granted, navigate to the documentation page you want to edit.
2. Scroll to the bottom of the page and click the Edit this page button.

Step 4: Authorize on GitHub

1. You will encounter a page with a 404 Error message saying, "What you're looking for does not exist."
2. Beneath the error message, click Authorize on GitHub.
3. Sign in using your GitHub account credentials.

After signing in, you will gain access to edit the documentation using Markdown.

What is Markdown?

Markdown is a way to make text formatted nicely without needing extra software. You just type designated symbols alongside the text, and it turns into formatted content like titles, lists, or links when viewed.

In other words, Markdown is a way to:

• Make headings to separate sections.
• Create bullet points or numbered lists.
• Add bold or italic text to emphasize something.

It’s easy and simple learn!

Basic Markdown Syntax

Here are the most commonly used Markdown features:

1. Headings:

   # Heading 1
   ## Heading 2
   ### Heading 3

2. Bold Text:

   **This text is bold**

3. Italic Text:

   *This text is italicized*

4. Lists:
   • Unordered List:

     - Item 1
     - Item 2
     - Item 3

   • Ordered List:

     1. First item
     2. Second item
     3. Third item

5. Links:

   [Link Text](https://example.com)

6. Images:

   ![Alt Text](https://example.com/image.jpg)

Step 5: Preview Your Edits

While editing, you can preview your changes:

1. Click the Preview button (eye icon) in the top-right corner.
2. Review your edits to ensure everything looks correct.

Step 6: Save Your Changes

1. When finished editing, click the Save button (floppy disk icon) in the top-right corner.
2. A dialog box will appear asking you to describe your changes briefly.
3. Enter a short description (e.g., "Updated Q&A section").
4. Click Commit to save your changes.

---

You have successfully edited the GYC documentation! If you encounter any issues, contact Caleb or Jonathan for assistance.