Skip to content

Commit 954d2c7

Browse files
authored
Merge pull request #997 from adlnet/test
1.0.3 Changes
2 parents 1cbca58 + 5acaafa commit 954d2c7

10 files changed

Lines changed: 6099 additions & 4646 deletions

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
~$*
22
*.html
33
.DS_Store
4+
*.swp

CONTRIBUTING.md

Lines changed: 257 additions & 123 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,49 @@
1-
xAPI-Spec
2-
=========
1+
# xAPI-Spec
32

4-
This Github repository contains the xAPI Specification. xAPI is a learning technologies interoperbility specification that describes communication
5-
about learner activity and experiences between technologies. You can [read the latest release of the specification here](xAPI.md). The group meets the first, second, and third Wednesdays of each month on GoToWebinar. You can register [at https://attendee.gotowebinar.com/register/7730918418468686596](https://attendee.gotowebinar.com/register/7730918418468686596)
3+
This Github repository contains the xAPI Specification. xAPI is a learning
4+
technologies interoperability specification that describes communication
5+
about learner activity and experiences between technologies. The specification is
6+
divided into three documents:
7+
8+
* Part One: [About the Experience API](./xAPI-About.md#partone)
9+
* Part Two: [Experience API Data](./xAPI-Data.md#parttwo)
10+
* Part Three: [Data Processing, Validation, and Security](./xAPI-Communication.md#partthree)
611

712
## Specification versions
8-
The current version of the specification is [1.0.2](https://github.com/adlnet/xAPI-Spec/blob/master/xAPI.md).
9-
[1.0.3](https://github.com/adlnet/xAPI-Spec/blob/1.0.3/xAPI.md) is currently being developed by
10-
the specification working group.
1113

12-
##What to do if the spec is unclear
13-
If when implementing the specification you find something is unclear or unhelpful, it may be that the others have similarly found that
14-
section unclear and that it has been fixed in the
15-
[development version of the specification (1.0.3)](https://github.com/adlnet/xAPI-Spec/blob/1.0.3/xAPI.md) which is being developed by the
16-
xAPI Working Group. You can and should look at the development version of the specification for reference, but be aware that this version has
17-
not been published, could contain errors and might be changed before it is released.
14+
The current version of the specification is
15+
[1.0.3](https://github.com/adlnet/xAPI-Spec/).
16+
17+
The next version of the specification has not been planned.
18+
19+
## What to do if the spec is unclear
1820

19-
If your confusions and concerns have not been addressed in the [development version)](https://github.com/adlnet/xAPI-Spec/blob/1.0.3/xAPI.md),
20-
you can help to improve the specification by [raising an issue here](https://github.com/adlnet/xAPI-Spec/issues). When raising an issue,
21-
please give as much detail as you can in regards to:
21+
If when implementing the specification you find something is unclear or
22+
unhelpful, you can help to improve the specification by
23+
[raising an issue here](https://github.com/adlnet/xAPI-Spec/issues). When
24+
raising an issue, please give as much detail as you can in regards to:
2225

2326
* Which part/parts of the specification you are reading.
2427
* Your understanding of what these parts mean.
25-
* The product and feature you are implmenting xAPI in; what's the use case you are trying to achieve?
26-
* How you would like the specification to be improved. Suggest some specific new wording if you like!
28+
* The product and feature you are implementing xAPI in; what's the use case you
29+
are trying to achieve?
30+
* How you would like the specification to be improved. Suggest some specific new
31+
wording if you like!
2732

28-
You'll need to [sign up for a GitHub account](https://github.com/signup/free) if you do not already have one in order
29-
to raise and comment on isues.
33+
You'll need to [sign up for a GitHub account](https://github.com/signup/free) if
34+
you do not already have one in order to raise and comment on issues.
3035

31-
You can discuss any issues before or after raising them on the [specification Google Group](https://groups.google.com/a/adlnet.gov/forum/#!forum/xapi-spec)
32-
and at our [weekly specification calls](https://attendee.gotowebinar.com/register/279276321478091778).
36+
You can discuss any issues before or after raising them on the
37+
[specification Google Group](https://groups.google.com/a/adlnet.gov/forum/#!forum/xapi-spec)
38+
and at our
39+
[weekly specification calls](https://attendee.gotowebinar.com/register/7730918418468686596).
3340

34-
##How you can contribute
35-
You'll need to [sign up for a GitHub account](https://github.com/signup/free) if you do not already have one in order
36-
to contribute to the specification.
41+
## How you can contribute
3742

38-
In addition to raising and discussing issues, you can contribute by:
43+
You'll need to [sign up for a GitHub account](https://github.com/signup/free) if
44+
you do not already have one in order to contribute to the specification.
3945

40-
* [Reviewing open Pull Requests](CONTRIBUTING.md#review-pr)
41-
* [Suggesting solutions to issues](CONTRIBUTING.md#suggest-solution)
42-
* [Making a Pull Request to address an issue](CONTRIBUTING.md#make-pr)
46+
The xAPI Spec Working Group meets
47+
the first, second, and third Wednesdays of each month on GoToWebinar. You can register at [https://attendee.gotowebinar.com/register/7730918418468686596](https://attendee.gotowebinar.com/register/7730918418468686596)
4348

44-
Click the links above to find out how to do each of these things.
49+
Please refer to the [Contribution guidelines](CONTRIBUTING.md) for further direction and a list of contributors.

0 commit comments

Comments
 (0)