Home

Welcome to the Learning Registry wiki! Here you can find links to documentation intended to help developers working with the Learning Registry.

Project Status

The US Department of Education ended support for the Learning Registry project on September 24, 2018, and made the project’s code base, documentation and archived metadata available to the public via GitHub and the Internet Archive. All relevant Learning Registry documentation has been consolidated to this GitHub wiki. Before decommissioning the public nodes, the resource metadata from each was published to Archive.org :

• LR Node 01
• LR Node 02
• GoOpen Node

Developers and interested collaborators can connect on the LR Google Group and LR Developers Google Group.

Read more about this announcement on the OET blog post

Developer Resources

• Glossary

• Common Data Schema Formats in Learning Registry - Examples of common data schema formats used in Learning Registry. Note: LR is data schema agnostic.

• Guide for Consuming Learning Registry Records - How to harvest and parse Learning Registry records with code examples.

• Slice API - The Slice API enables users to retrieve a subset of records.

• API Examples - A page for sharing examples of using the LR APIs.

• Data Examples - A page for sharing examples of various data formats found within the LR

• Learning Registry in 20 Minutes or Less - A full walk through of creating, uploading, downloading, verifying, updating, and replacing envelopes.

• Known Public Keys - A list of known Public Keys of publishers in the LR.

Publishing Resources

• Publishing using OAuth and Node Signing - Code samples showing how to publish to a node with Node Signing capabilities enabled.

  • in Python
  • in PHP
  • in Java

• Publishing guidance using OAI-PMH - A short Google Doc with code examples and links to working code projects to pull data from OAI-PMH repositories and push the data into the Learning Registry.

If you are publishing data, we recommend publishing documents in batches of 100 documents in each publish post. Each batch of 100 documents should take less than 10 seconds to publish.

Installing and Setting Up an LR Node

The code hosted here on GitHub is used to run a Learning Registry node implementing the Learning Registry Technical Specification v0.51.0. Listed below are resources to help install and setup a Learning Registry node on different operating systems.

• Linux Installation - Instructions for setting up a node on Ubuntu 12.04 LTS.

• AMI Installation - Instructions for setting up a node using an existing Amazon Machine Instance.

• Windows Installation - Instructions for setting up a node on a Windows 7 64-bit environment.

• OS X Installation - Instructions for setting up a node on Mac OS X.

• PlugFest2 Virtual Machine - Jim distributed LR Virtual Machines at the PlugFest2 event loaded with an LR node instance and various tools.

• Node Setup FAQ - Frequently Asked Questions when setting up or running a node.

Node Customization and Maintenance

• Data Services - A design pattern to help you quickly develop a solution to extract relevant data from your Learning Registry Node.

• Upgrading a Node - Instructions for upgrading a node to the latest release.

Get Involved

Are you interested in making the Learning Registry a faster, better platform?

• Community Projects - Please share here any utilities, demonstrations, or extensions to the core code.

• Contributing - Information about the easiest way to collaborate with the core development team.

• Releases - Information on software releases.

• Release procedure - Describes general procedure for a new release.

Getting Help

• Report a bug: https://github.com/LearningRegistry/LearningRegistry/issues

• Learning Registry Developers List: http://groups.google.com/group/learningreg-dev

• Troubleshooting guidance