| title | layout |
|---|---|
Contributing to Lessons |
generic |
Items necessary for this step:
- your own GitHub account online
Instructions
Forking a repository
To submit content to the Skillbuilding Hub, you need to first create a fork of DataONEorg's Education repository. This means you will be creating your own private copy of the Education repository and storing it in your GitHub account online. Here, in your fork, you can edit and upload content without affecting the original.
The forking process will take a few minutes at most. Once you've perfected your changes, you will later merge the changes you have made back into the original repository.
1. To start the forking process, go to DataONEorg's Education repository
2. In the right hand corner of DataONEorg's Education repository, click the "fork" button.
- Make sure you are logged into your GitHub account before you press fork.
3. The forking process is complete! Check "your repositories" in your account to make sure the Education repository was successfully forked.
4. Download a PNG file of your organization's logo onto your computer
- If you are associated with a university, company, or other organization you must include their logo along with your submission.
- Once you have downloaded the logo, make sure to name the .PNG after your organization
- For now the PNG will be saved on your desktop, but later we will upload it to a specific location in DataONE's GitHub repository
Items necessary for this step:
- a text file (e.g. a Word document, Notepad, Google Docs, any text editor, etc.)
- your organization's logo (.PNG only)
Instructions
Creating the "frontmatter" file
For every best practice submitted to the Skillbuilding Hub, the document must also have a front section containing metadata information about the best practice. This section of the best practice is also called the "frontmatter".
The following metadata information is needed when submitting educational materials to the Data Management Skillbuilding Hub:
- title:The full title of your best practice
- layout: is always bestpractice_cover
- tags: a list of (short) keywords describing the content of the best practice text
- Click here for a list of currently existing tags
- step: a list of one or more steps of the data lifecycle to which this best practice applies.
- related: (optional) Choose one or a few best practices that are related to yours. List their identifier -- an identifier is the first three words of the title, separated by dashes.
- update: the date this best practice was created
- author: a list of authors that created the best practice
- organization: name of organization that oversaw the creation of the best practice
- org_url: website of the organization, organization logo will open this webpage when selected
- org_logo: name of the organization’s logo file (this must be a .png file).
- categories: this must be listed as [“Best Practice”]
1. Copy the following text block and paste it into your empty text file
---
title:
layout:
tags:
step:
related:
update:
author:
organization:
org_url:
org_logo:
categories:
---
2. Fill out the appropriate information for each of the categories
- Here is an example that follows the proper formatting. Note that spaces, indents, lines, and dashes are actually very important here, so be sure to follow the formatting of the example as closely as possible!
---
title: Advertise your data using datacasting tools
layout: bestpractice_cover
tags:
- access
- data services
- discover
step:
- discover
related:
- provide-a-citation
- provide-identifier-for
- recognize-stakeholders-in
update:
- May 11, 2011
author:
- Cindy Parr
organization: DataONE
org_url: http://www.dataone.org
org_logo: DataONE.png
categories: ["Best Practice"]
---
Now your frontmatter information is completed. Save your text file, and we will copy and paste this text at a later step in the submission process.
3. Creating your best practice document In your fork, open up the the appropriate folder and click "Create New File."
- Go to `(yourGitHubAccount)/Education/_bestpractices/bestpractices` and click Create New File, located in the upper right-hand corner
4. Name your file
Name your file for the first three words of the title, separated by dashes, and followed by the .md extension.
5. Copy the "frontmatter" saved in your text file from Step One and paste it here into the markdown (.md) file
- Be sure to include the three dashes at the beginning and end of the section
6. Add the content of your best practice directly into your markdown file
- You will be putting your content immediately after the three dashes "---"
- The format for the content of a best practice should be as follows:
- A description of the best practice
- Description Rationale
- Additional Information
- Examples
7. Commit your Changes
- Scroll to the bottom of your markdown document to commit your changes
- Committing will submit the markdown file to your fork of the Education repository
8. Uploading your organization's logo
- Go to `(yourGitHubAccount)/Education/_bestpractices/bestpractices/logos` in your fork of the Education repository.
- Click on "Upload Files" and drag your logo here.
- Commit your change
9. [Optional Step] Adding images
- If your best practice includes images in it, you must upload them to your fork of the Education Repository.
- Go to `(yourGitHubAccount)/Education/_bestpractices/bestpractices/images` in your fork
- Upload your image to the "images" folder, and give each image a unique identifier.
- An image name should begin with it's best practice identifier, followed by an underscore and a word that describes the image itself
- Images can be .JPG or .PNG
- Once all the images are uploaded, commit your change.
Instructions
Creating a pull request means that you are requesting the original repository to "pull" or accept all the changes you just made.
- Do not complete this step until all of the materials necessary for your submission have already been uploaded to GitHub!
That's it! You have completed all the steps. Once someone has approved your pull request, you will be able to find your submission in DataONE's repository.
The stylesheets are defined in resources/styles, and rendered to resources/dataone.css using lessc (just type make from the root).
access, analyze, annotation, assure, backup, calibration, citation, coding, collect, controlled vocabulary, data archives, data consistency, data creators, data management plan, data model, data normalization, data processing, data quality, data services, data source, data sources, database, date, describe, disaster, recovery, discover, documentation, file, system, flag, format, geography, geospatial, image, integrate, location, measurement, metadata, missing, values, ontologies, parameter, plan, preserve, provenance, qualify, quality, replicable data, restore, standards, storage, tabular, taxonomy, terminology, time, units