10.10 Handbook

This page explains how to contribute to the handbook.

How to suggest changes

  1. Navigate to the page you would like to change
  2. Click on “Help improve this page”, sign in, and the “Edit this file” button
  3. Add your changes in GitHub markdown
  4. Commit the changes to a new branch
  5. Assign the maintainer to review and merge your changes

Principles

  • Checklists should be simple, structured, and actionable
  • Add explicit links to the confidential data store (see example)
  • Add links to other parts of the handbook or external resources to avoid replicating contents
  • If the page requires scrolling, add a table-of-content. Exclude second-level headings from toc.
# Heading
{: .no_toc }

## Table of contents
{: .no_toc .text-delta }

- TOC
{:toc}

...

### Heading 3
{: .no_toc }
  • Confidential data, such as grades and student identities are not be stored in the handbook. The following callout signals that confidential data is available in our separate data store:
{: .confidential } 
> Confidential data is stored on the [Nextcloud](http://url.com){: target="_blank"}.

Confidential data is stored on the Nextcloud.

  • Avoid renaming files or changing the structure of directories. If files need to be renamed, include a redirect in the header:
---
layout: default
title: ...
redirect_from:
  - /docs/20-research/20_processes/20.30.pre-submission.html
---

Deployment

The handbook is hosted on GitHub pages. The deployment may take a few minutes. You can check the status at

GitHub

How to copy the handbook

To create your own copy of the the handbook, clone the repository.

More detailed instructions and best practices will be available shortly.

Linked resources