Contributing Updates to EdMatrix
EdMatrix would not be possible without the generous contributions from many people. We encourage individuals and organizations involved in education standards work to submit updates and corrections.
Step 1: Access the source code
Download the raw form of a file for a standard you intend to update. If contributing a new standard, download Template.md.
Step 2: Write or update the standard description
Standard descriptions are in MarkDown format. The majority of the information is in the YAML front matter which begins and ends with lines consisting of three dashes. Following the front matter is a description that uses markdown formatting.
Here’s an example:
--- title: Soliloquy Markup stdurl: http://Soliloquy.example/markup org: Soliloquy Standards Initiative types: "Content Metadata, Content Packaging & Integration" datalayers: "1,2,3" edlevels: "Primary, Secondary" region: "Global" --- **Soliloquy Markup** is a publishing and distribution format for digital lessons. Soliloquy and the associated standard are fictional, invented just for this sample.
The title should be the concise name by which the standard is known. Acronyms are common.
This should be the URL of a page that gives an overview of the standard, its purpose, use, and governance. The page should exist on the standard organization’s website. Generally you pick the best page for an overview which has links to the standard specification itself.
The name of the organization that governs the standard.
The type or types of data or information that are covered by the standard. Please consult A Taxonomy of Education Standards for descriptions of the types.
As of 1 August 2019 the taxonomy document referenced above is out of date and doesn’t fully match the types listed below. Please reference other standards and the EdMatrix diagram as you choose your types. The taxonomy will be updated shortly.
Select one or more from the following list. If more than one type is covered by the standard, the type names should be separated by commas. Regardless, the list should be enclosed in quotes. For example:
"Student Data, Educator Data"
- Student Data
- Educator Data
- Institutional Data
- Competency Data
- Content Metadata
- Content Packaging & Integration
- Foundational Standards
- Competency & Achievement
- Design & Practice
The data layers are from A Four Layer Framework for Data Standards. Standards associated with “Competency & Achievement” or “Design & Practice” are not associated with data layers and for those, this field should be left blank. For all others, list the just the numbers of the layers separated by commas. The whole list should be enclosed in quotes. Examples:
List one or more education levels enclosed in quotes and separated by commas. If all levels are covered you may simply use
"All". Select from the following list:
This list follows the North American pattern. You may choose terms in common to other world regions. For example “Tertiary” is commonly used in the UK.
This field is optional. It designates one or more regions where the standard is targeted or intended to be used. As with other fields, enclose the list in quotes and separate values with commas. The following are recommended regions though you may choose others such as country names.
- Latin America
- North America
This field is optional. It indicates the origin of the description (not of the standard itself). Typically it is a reference to a person, group, or organization. The information will not appear on the website but will be retained in the source code for reference by people making future changes.
Following the front matter, the body of the document should contain a description of standard. The first paragraph will show in the standards table. The balance of the body (if any) will only appear in the detail page - accessed by clicking (more) in the table. Use Markdown syntax to incorporate rich text features including links.
The full name of the standard (often an expansion of the acronym) should appear within the first sentence of the description.
Step 3: Submit your update or addition.
There are three ways to submit your update. If you are familiar with Git and with GitHub (or are willing to learn) then use the Fork & Pull method. Otherwise, you can create an issue and attach your update. Both of these methods require that you create a free Github account.
Fork & Pull Method
The Fork & Pull approach is the standard way to submit an update to any GitHub project. First, you create a personal fork of the project. This is a copy of the project in which you can make any changes and try them out. Then you submit a pull request recommending that the coordinator of the project incorporate your changes into the primary copy. The GitHub pull request mechanism initiates an online discussion where you can describe your update and the coordinator can ask questions.
Create an Issue Method
Browse to the EdMatrix Issues Page on Github. Create an issue, tag it as “enhancement” and attach your new or edited markdown file from step 2.
Thank you for your interest in EdMatrix. And thanks in advance for your contributions to making it a valuable resource for everyone working in education technology.