Skip to content

/docs

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
New issue

Corrects spelling and grammar #1

Merged
merged 6 commits into from 4 months ago
+16 −16

Labels

Milestone

No milestone

Assignee

No one assigned

3 participants

Ryan Smith Dave Tosh James Mullaney
Ryan Smith
Collaborator
ryansmith94 commented

I was a little bored, wanted to help out, then spotted some spelling mistakes/typos and here we are :smiley:

ryansmith94 added some commits
Ryan Smith ryansmith94 Adds some commas and apostrophes. … 
- `learners` was changed to `learners'` because it's possessive.
- Commas were added for easier reading, for example `Using this data organisations can` should read `Using this data, organisations can` or `Using this, data organisations can`.
 b67e7c6
Ryan Smith ryansmith94 Corrects spelling. … 
Changes `translation Learning Locker` to `translating Learning Locker`.
 c5541bc
Ryan Smith ryansmith94 Corrections for spellings and typos. 965c72f
Ryan Smith ryansmith94 Corrects spelling. 7083c4e
Ryan Smith ryansmith94 Corrects spelling. 02199ef
Ryan Smith ryansmith94 Corrects spelling and tweaks wording. 7e51b7c
Dave Tosh davetosh merged commit 2ac5fb6 into from
Dave Tosh davetosh closed this
Dave Tosh
Owner
davetosh commented

Thanks!

Ryan Smith
Collaborator
ryansmith94 commented

No worries

James Mullaney
Owner
ht2 commented

Great work Ryan, thanks for this!

Ryan Smith
Collaborator
ryansmith94 commented

Thanks, you're welcome :smiley: I'd potentially think about renaming the contributing file so that Github doesn't mistake it for contribution guidelines. See this GitHub blog post if you're unaware of what I mean https://github.com/blog/1184-contributing-guidelines.

James Mullaney
Owner
ht2 commented

Ha good catch! Yea, changing to something contributingtoll.md should prevent any problems moving forward. I'll open up a todo and Dave (who's on holiday this week...I thought....!) can look at fixing it next week.

Ryan Smith
Collaborator
ryansmith94 commented

Nice one, I would have put in a pull request for it, but I'm not entirely sure how this is wired up to the website.

Dave Tosh
Owner
davetosh commented

We are not doing anything smart with the docs site yet so all pull requests into master more than welcome. Eventually, time permitting, I want to sync this master branch to the site for automatic updates but at the moment the process is manual.

Ryan Smith
Collaborator
ryansmith94 commented

Ok @davetosh, I'll make a pull request then that renames the contributing file in response to #2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jun 09, 2014
  1. Ryan Smith

    Adds some commas and apostrophes. …

    ryansmith94 authored 
    - `learners` was changed to `learners'` because it's possessive.
- Commas were added for easier reading, for example `Using this data organisations can` should read `Using this data, organisations can` or `Using this, data organisations can`.
    b67e7c6
  2. Ryan Smith

    Corrects spelling. …

    ryansmith94 authored 
    Changes `translation Learning Locker` to `translating Learning Locker`.
    c5541bc
  3. Ryan Smith

    Corrections for spellings and typos.

    ryansmith94 authored
    965c72f
  4. Ryan Smith

    Corrects spelling.

    ryansmith94 authored
    7083c4e
  5. Ryan Smith

    Corrects spelling.

    ryansmith94 authored
    02199ef
  6. Ryan Smith

    Corrects spelling and tweaks wording.

    ryansmith94 authored
    7e51b7c
This page is out of date. Refresh to see the latest.
4 Translation.md
View
@@ -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 contributing.md
View
@@ -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)
@@ -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.
@@ -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)
@@ -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 index.md
View
@@ -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.
6 installation.md
View
@@ -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)
@@ -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)
@@ -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 reporting_api.md
View
@@ -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**
4 statements.md
View
@@ -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
@@ -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)));
- }
+ }
Something went wrong with that request. Please try again.