Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (51 loc) · 3.34 KB

CONTRIBUTING.md

File metadata and controls

62 lines (51 loc) · 3.34 KB

Contributing

Thank you for contributing to the FTC community docs! You are enhancing the knowledge base for current and future FTC teams, making FTC better for everyone.

Formatting Resources

Update an Existing Page

  1. Locate the page on the live website.
  2. Click the edit icon. The button is located to the right of the page title.
  3. Make your desired changes in the GitHub interface.
  4. Once you are done, click the green "Commit changes" button.
  5. Follow GitHub's instructions to create a pull request for your changes. For this type of change, set the target branch to content.

Once you have made your changes, we will review them, and if they pass, we will merge your pull request and it will soon become part of the documentation.

Creat a New Page

  1. Go to source/docs folder in GitHub.
  2. Open the appropriate folder based on the topic of your new page.
  3. Create a new .md file.
  4. Title your file:
    1. On line 1, put # in front of your page title.
  5. Populate your file with the information you wish to add.
  6. Once you are done, click the green "Commit changes" button.
  7. Optional: If you feel inclined to make your page visible, you may do so. Otherwise, skip this step and we can do this for you.
    1. Open source/mkdocs.yml.
    2. Locate the nav property (this is located at the top).
    3. Add the path to your file in the appropriate location.
    4. Once you are done, click the green "Commit changes" button.
  8. Follow GitHub's instructions to create a pull request for your changes. For this type of change, set the target branch to content.

Adding Your Team Page

  1. Go to source/docs/teams folder in GitHub.
  2. Create a file with this format: [team-number].md
    • If your team number is 12345, name your file 12345.md.
  3. Populate your file with the information you wish to add.
  4. Once you are done, click the green "Commit changes" button.
  5. Optional: If you feel inclined to make your page visible, you may do so. Otherwise, skip this step and we can do this for you.
    1. Open source/mkdocs.yml.
    2. Locate the nav property (this is located at the top).
    3. In the Teams section, add an entry for your new page with the following format: teams/[team-number].md. Mind the numerical order.
    4. Once you are done, click the green "Commit changes" button.
  6. Follow GitHub's instructions to create a pull request for your changes. For this type of change, set the target branch to content.

Editing Something Else

  1. Fork this repository.
  2. Clone your fork onto your machine.
  3. Create a virtual Python enviornment for this repository.
  4. Install the dependencies from the list contained in source/requirements.txt.
  5. Navigate to the root folder of this repository in your terminal
  6. Run the appropriate activation script for your virtual enviornment and system
  7. Change your directory to source
  8. Run mkdocs serve, and open the link it outputs in your browser.
  9. Make your desired changes.
    • You may need to update requirements.txt if your changes require another Python library to build the website
  10. After verifying your changes work, push the code to your fork.
  11. Contribute your fork as a PR, and set the target branch to config.