Format

The deliverable format for this report is a git repository.

Git is a distributed version control system for the management of computer files. Git tracks changes that are made to files so as to coordinate the work of multiple contributors working collaboratively.

A git repository is a folder of computer files managed by git, such that multiple contributors can access and make changes to files without overwriting one another.

Although there is only one author to this report, the idea behind it is to put into place collaborative working methods which can expand over time to allow for multiple contributors.

There are many past contributors to grunt's public-facing digital assets who are only partially acknowledged through code comments—which are not easily accessible. Recognizing the work of contributors through mentions, links, and commit history better-rewards the contributions made to grunt's digital ecosystem.

Git is offered under the GNU General Public License — a free and open-source software license — and works on all major computer operating systems.

Markdown

The content of this report is written in Markdown, a lightweight markup language for creating formatted text using a plain-text editor. A markdown processor can create .PDF, .DOCX, and HTML outputs, among others.

Web-based Delivery

This report is accessed through the web browser.

The source code for the report can be found here.

This report is intended to be a "living document" that can change over time.

This report is digital, so that it can be easily accessed, edited, and contributed to.

This report has permalink section headings so that sections of the report can be easily referenced in discussions and funding reports—it is often helpful to direct someone to the information you want them to have without asking them to search through pages in a .PDF report.

How to use permalink section headings

If you click the "#" icon that appears when you hover any section heading in this report, you can copy the address in the URL bar to directly reference that heading.