This repository contains documentation for Minnesota's implementation of the Ed-Fi alliance standard. The Minnesota Department of Education (MDE) is implementing Ed-Fi to help improve the collection of required educational data from Minnesota school districts. Learn more at MDE's Ed-Fi web page and at the following links:
In June-July of 2020, MNIT supporting MDE converted much of the 2020-2021 school year documentation to markdown files. While the official documentation remains in Word and Excel within this repository, the markdown files at the top level of this repository represent a pilot of storing and maintaining the documentation in markdown, starting with:
We will also use this repository to store additional documentation and links that may be useful to Districts and Vendors. See the following:
- Descriptors and Resources. This document contains additional information about specific descriptors and data resources that can prove useful in understanding the system.
- MARSS Translation Guide. Also known as the "MDE Translation Guide", this document on the MDE website describes the technical specification and definitions used when extracting information out of the Ed-Fi ODS and translating into the data used by the Minnesota Automated Reporting Student System (MARSS).
JSON files of sample data are being loaded into the data directory in an attempt to assist developers with understanding the Ed-Fi ODS API.
As part of this documentation effort, we are also using Github to manage technical issues. See the Issue List for examples.
There are two ways to view this documentation:
- in the Github repository where
https://github.com/mn-mde-edfi/is in the beginning of the URL in your browser. Raw markdown files are in the "code" section, with links to each other. Github renders this markdown as readable content. - in a "Web Version" in which Github attempts to automatically render the markdown files as HTML, and where
https://mn-mde-edfi.github.io/is in the beginning of the URL in your browser
In the Github repository, you may have trouble viewing embedded images embedded in the markdown. You have two options to remedy this: "click through" to view the image in the repository, or view the web version.
In contrast, the web version does not render markdown tables into HTML tables, so tables are best viewed directly in the Github repository.