Skip to main content

How to Contribute

Let's add some documentation!

Standards​

Every documentation page should follow roughly the same standards to promote parity and readability across the entire site! Additionally, you may be interested in how to bold or italcize text, or how to properly make tables, add images, or link between doc pages. So, before contributing...

Make sure to review our Standards

Contributing​

Contributing to the docs site should be relatively quick and easy, with our goal being to break down any barriers of entry so the site actually sees use. We've got to work together to keep our documentation accurate, up to date, and readable.

So, let's do this! Below is guide on how to contribute based on if you are familiar with GitHub and have a seat or not.

You're a Developer / GitHub Seat Owner​

If you're a devloper the contribution process becomes exceedingly easy. It's as simple as cloning the repo and adding your documentation. Either way, a rough guide is laid out below:

  • Create a ticket for your documentation/edit - explaining what you plan to cover or change
  • Create a branch for your addition/edit
  • Clone the repo and check-out your branch
  • Create your new file or make your edit and push to GitHub
  • Open a PR to Main and get your changes reviewed by a relevant team member
  • Merge to Main

Congrats your changes are live! 🎉

You're a Non-Developer​

If you don't have developer experience or don't have a GitHub seat, you'll have to lean on someone who does in order to add your documentation. Don't worry, though, you'll still be the main force behind the contribution! Let's jump into a rough guide, leading with what person is doing what:

Non-developer:

  • Create the documentation page via word or any text editor
    • Be sure to keep styling minimal
  • Request a developer to add the document for you

Developer:

  • Create a ticket and branch for the addition/edit
  • Format the document into an mdx file
  • Important: While adding the file, if applicable, review the documentation
  • Localhost and 'print' the page to a PDF, then share this page with the author/non-developer

Non-developer

  • Review the PDF version
  • Get the PDF version reviewed by at least one other relevant team member
  • Give approval to the developer to host the addition/edit - citing who reviewed it

Developer:

  • Open a PR to Main
  • Merge to Main (Force merge approval may be required from an organzation manager)

Congrats your changes are live! 🎉

Not sure what developer to ask?​

If you need help hosting documentation, but you aren't sure who to ask, the current contribution owner can help!
Currently the owner is Zach Sedlack (zach.sedlack@fortisureit.com)





Citing Note​

This website's source code is hosted on our GitHub organization. It uses Docusaurus as a framework. This project uses markdown to write documentation and then Docusaurus turns it into the site you see.

Last updated on by Zach Sedlack