Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 3.15 KB
Raw

Guidelines for contributors and content editors

Thank you for your interest in contributing to this educational material! This document provides an introduction to the ways the lessons are organized, the tools we use to display them, and the type of modifications we expect.

This repository was developed by the DataONE Community Engagement and Outreach Working Group and continues to be maintained by members of this team. Information about suggesting changes or adding new content may be found below.

Structure of the modules

Each of the educational modules is generated from markdown documents. These guidelines will walk you through the repository organization, the markdown basics, and any additional information.

Repository organization

Every lesson is a single folder within the lessons directory. Each lesson folder is called XX_keyword, where XX is the lesson number, and keyword is a brief description of the lesson. The slides themselves are in a file called index.md. Do not use another filename. For example, the demonstration lesson markdown file can be viewed here. This demonstration lesson showcases most of the features you can use in your slides.

You are free to add other directories to your lesson. Images go in images, and PDF files in pdf. For example, a lesson repository could look like:

01_management/
  index.md
  images/
    image1.png
    image3.jpg
  pdf/
    one-pager.pdf

Informations about the tools used

The markdown documents are rendered into a website using Jekyll. The slides themselves are rendered using remarkjs. The rendering is done using github pages, which builds the site from the master branch. You can build the site locally with jekyll serve -w, and it will be available at http://localhost:4000 for you to review.

The stylesheets are defined in resources/styles, and rendered to resources/dataone.css using lessc (just type make from the root).

How to contribute

Adding content

  1. Create a fork of the repository into your github account
  2. Modify the files that you want to change
  3. Submit a pull-request against the master branch of this repository
  4. Your changes will be reviewed

Page not rendering?

Check that the title field of the YAML header (the first line of each lesson) is in quotes.

Workflow for suggesting changes

  1. Open an Issue on this repository.
  2. Your suggestions will be reviewed by a member of the DataONE CEO Working Group.
  3. Changes will be pushed to the repository by a CEO Working Group team member regularly/as needed.

Thank you for your interest in making these data management education modules more useful!