Skip to content
This repository was archived by the owner on Sep 12, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Translation.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Translations
============

We are looking for people interested in translation Learning Locker. If you would like to help out, we are currently using a service called Transiflex. You can visit the [Learning Locker page](https://www.transifex.com/projects/p/learning-locker/), create a project and translate.
We are looking for people interested in translating Learning Locker. If you would like to help out, we are currently using a service called Transiflex. You can visit the [Learning Locker page](https://www.transifex.com/projects/p/learning-locker/), create a project and translate.

Currently Learning Locker is available in:

* Dutch
* Turkish
* Italian
* English
* English
10 changes: 5 additions & 5 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Contributing
============

There are many ways you can contribute to the Learning Locker projects including:
There are many ways that you can contribute to the Learning Locker projects including:

- [Code](#code)
- [Testing](#testing)
Expand All @@ -15,7 +15,7 @@ There are many ways you can contribute to the Learning Locker projects including

### Pull requests

The best way to get started with pull requests is to create an ticket in our tracker then address the issue / enhancement in your pull request. If the pull request is in response to a bug, then no extra detail is required, however, if you are proposing new functionality or a rewrite of existing code, then please include a detailed description with your pull request.
The best way to get started with pull requests is to create a ticket in our tracker then address the issue / enhancement in your pull request. If the pull request is in response to a bug, then no extra detail is required, however, if you are proposing new functionality or a rewrite of existing code, then please include a detailed description with your pull request.

We are certainly open to pull requests and want to encourage people to get involved.

Expand All @@ -29,7 +29,7 @@ We are certainly open to pull requests and want to encourage people to get invol

#### Feature request

If you have a feature request for Learning Locker, then create a ticket in out tracker and make you you select the label 'proposal'.
If you have a feature request for Learning Locker, then create a ticket in our tracker and make sure you select the label 'proposal'.

> [Issue tracker](https://github.com/LearningLocker/learninglocker/issues)

Expand All @@ -50,10 +50,10 @@ If you would like to help us document Learning Locker, here are the steps.
<a name="translations"></a>
## Translations

We are looking for people interested in translation Learning Locker. If you would like to help out, we are currently using a service called Transiflex. You can visit the [Learning Locker page](https://www.transifex.com/projects/p/learning-locker/), create a project and translate.
We are looking for people interested in translating Learning Locker. If you would like to help out, we are currently using a service called Transiflex. You can visit the [Learning Locker page](https://www.transifex.com/projects/p/learning-locker/), create a project and translate.

<a name="usecases"></a>
## Use Cases

<a name="promo"></a>
## Promotion
## Promotion
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Welcome
<a name="about"></a>
## About

Learning Locker is the open source Learning Record Store; a type of data repository designed to store learning activity statements generated by xAPI (Tin Can) compliant learning activities. Organisations use Learning Locker to [store, sort and share learning data](http://learninglocker.net/features/benefits/) as generated by their learners. Using this data organisations can better understand the learning activities of their workforce, assess the impact of training and development and customise learning experiences based on learners past performance.
Learning Locker is the open source Learning Record Store; a type of data repository designed to store learning activity statements generated by xAPI (Tin Can) compliant learning activities. Organisations use Learning Locker to [store, sort and share learning data](http://learninglocker.net/features/benefits/) as generated by their learners. Using this data, organisations can better understand the learning activities of their workforce, assess the impact of training and development and customise learning experiences based on learners' past performance.

We’re an open source community effort. To understand a little about where we are heading see our future [product roadmap](http://www.learninglocker.net/roadmap). If you want to know more about getting involved please see our [community pages](http://learninglocker.net/community/).
We’re an open source community effort. To understand a little about where we are heading, see our future [product roadmap](http://www.learninglocker.net/roadmap). If you want to know more about getting involved, please see our [community pages](http://learninglocker.net/community/).

> Learning Locker only supports xAPI v1.0 and above. It is not suitable for platforms still using an earlier version of xAPI. At this time there are no plans to provide backwards compatibility for older versions of the spec.

Expand Down
6 changes: 3 additions & 3 deletions installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Installation

Learning Locker is built upon the excellent [Laravel](http://laravel.com). Laravel has great documentation, so, we are going to focus on the
key areas for Learning Locker as well as a couple of gotcha's. You will see reference to the Laravel docs throughout as it doesn't make
sense to duplicate the efforts of a vibrate and growing community.
sense to duplicate the efforts of a vibrant and growing community.

[Laravel Docs](http://laravel.com/docs)

Expand All @@ -27,7 +27,7 @@ sense to duplicate the efforts of a vibrate and growing community.
<a name="install-composer_download"></a>
#### Via download

If you would prefer, you can grab the latest tagged release and uppack it into your directory.
If you would prefer, you can grab the latest tagged release and unpack it into your directory.

[Releases page](https://github.com/LearningLocker/learninglocker/releases)

Expand Down Expand Up @@ -99,4 +99,4 @@ You can change various settings such as debug mode, default language and timezon
<a name="aws"></a>
## Installation on AWS

There are very detailed instructions for getting [Learning Locker running on AWS](http://cloudboffins.com/advanced-projects/learning-locker-lrs-free-server-part-1/) (it's a five part series)
There are very detailed instructions for getting [Learning Locker running on AWS](http://cloudboffins.com/advanced-projects/learning-locker-lrs-free-server-part-1/) (it's a five part series)
4 changes: 2 additions & 2 deletions reporting_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Reporting API

The page details the custom Learning Locker API. This should not be confused with the xAPI as detailed by the [xAPI spec](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).

The purpose of this custom API is to provider developers building reporting type tools with a few additional views of the data within an LRS.
The purpose of this custom API is to provide developers building reporting type tools with a few additional views of the data within an LRS.

<a name="analytics"></a>
## GET - api/v1/query/analytics

Parameters | Type | Description
----|------|----
filters | Object | Object of key:value objects, where the key denotes the context path and the value is the value to filter with. Values can be string or array.
filters | Object | Object of key:value objects, where the key denotes the context path and the value is the value to filter with. A value can be a string or an array.

**Example**

Expand Down
4 changes: 2 additions & 2 deletions statements.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ For v1.0 of Learning Locker we have set the following indexes on a statements do
* lrs._id & statement.verb.id
* lrs._id & statement.actor.mbox

> It should be noted that this is only a first pass at indexing statements. This need full testing and revision to make sure we can optimise querying. So, if you have any suggestions then [please get involved](http://docs.learninglocker.net/contributing) and help out. Thanks.
> It should be noted that this is only a first pass at indexing statements. This needs full testing and revision to make sure we can optimise querying. So, if you have any suggestions then [please get involved](http://docs.learninglocker.net/contributing) and help out. Thanks.

<a name="quirks"></a>
## Quirks
Expand All @@ -97,4 +97,4 @@ MongoDB doesn't allow full stops (.) in keys. Therefore, we replace all full sto
//convert array to json as this is faster for multi-dimensional arrays (?) @todo check this out.
function replaceHtmlEntity( $array ){`
return json_decode(str_replace('&46;','.', json_encode($array)));
}
}