General Notes on Editing Pages

Git Repo Etiquette

If you are involved in the initial development, you may make commits directly to the main branch. Once we are in production, there will be a staging branch, and we will ask everyone to commit against that. Once changes have been reviewed there, one of the site maintainers will merge the changes from staging into main. At this point, we are not requiring folks to fork the repo and submit PRs, but that may become the case in the future.

Also note that there is a file called history.json that will likely get updated as you are working in the development environment. Please DO NOT include this file in any commit but DO NOT add it to the .gitignore file. You will need to manually exclude it from commits (that process will vary depending on if you are using the git command line or a desktop client). Neither of these things are catastrophic, but doing either will cause issues that will require intervention by one of the site maintainers. So please be kind and follow these instructions.

Formatting

The site uses mdx files, which allow a combination of Markdown and JSX for formatting and some advanced functions. If you are unfamiliar with Markdown, please see:

https://www.markdownguide.org/

We are using Patternfly for layout, so if you need to do any formatting that can't be handled with Markdown, you will need to import the appropriate Patternfly JSX modules for us. For more information about PatternFly, please see:

https://www.patternfly.org/v4/