Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

README

This template is meant to be used as a base for all future project pages. It was created to ensure project pages are consistent in their structure and presentation, to ease user ability to sort through relevant information. This README section obviously should not appear on any project pages. Ideally, the leads of team or squads can utilize this template when creating a page for their project, with occasional upkeep as the project changes over time.

The project page template begins with the About section, then concludes with the Meet the Members section. Under each headline is a brief explanation for what content will exist there, which should be removed from the final project page.

When copying this template to use for a project, remove this README. Also remove any Notes that are added to clarify aspects of the template.

Customization

The format of this template is meant to be flexible enough that most information for a project has a relevant section to be placed. However, customization is also allowed on the part of the editor in order to include additional resources, sections, or visual additions.

If there is no content that can be added to a section and the section would be left empty, that section's header should be removed from the project page entirely. If the editor wants to create an entirely new section for their page, that is also acceptable. New sections should be added underneath the Background section but above the How to Join section. All section headlines should use Heading 2, while subsection headlines should use Heading 3. Text will be standard Paragraph format.

Even for pages with dense content, avoid using a double or multi column layout for the page.

Any notes that are added later in the template should be removed.

About

This section will be the most basic overview of the project. Ideally this section should only be a few sentences but may require more detail to properly explain the project. It should also list the activity status of the project beneath any descriptions or content.

...

Website Board/Additional Forum: Additional site link

Note: Hyperlinks should be formatted as "(Website/tool) link for (function)", ex: Zoom link for computer or desktop

How to Contribute

Once a new user has completed prerequisites and joined the relevant communication channels, he or she will be ready to begin contributing. This section will include links to team forums in which members can edit, create, or contribute, such as Jira.

...