Add documentation #60

cmfcmf · 2018-07-11T13:05:39Z

cleanup README
cleanup LICENSE
write a bunch of docs

If you find any issues such as typos, feel free to directly push to this branch.

This fixes most of #25 and depends on #62 and #57.

corinnaj · 2018-07-31T07:21:57Z

README.md

-[![Coverage Status](https://coveralls.io/repos/github/frederike-ramin/gamification/badge.svg?branch=coveralls)](https://coveralls.io/github/frederike-ramin/gamification?branch=coveralls)
-# gamification
+[![Build Status](https://travis-ci.com/schul-cloud/gamification.svg?branch=master)](https://travis-ci.com/frederike-ramin/gamification)
+[![Coverage Status](https://coveralls.io/repos/github/schul-cloud/gamification/badge.svg?branch=coveralls)](https://coveralls.io/github/frederike-ramin/gamification?branch=coveralls)


The link still points to the old repository

corinnaj · 2018-07-31T07:31:50Z

README.md

 ## Testing

-Simply run `npm test` and all your tests in the `test/` directory will be run.
+Run `npm test` to run all tests. Use `npm coverage` to run tests and generate coverage.


Maybe change this to: "Run npm test to run all linters and tests. Use npm coverage to also generate coverage."
I find that makes it a bit clearer, especially since tests won't even run if the linter fails.

coveralls · 2018-08-07T11:12:12Z

Pull Request Test Coverage Report for Build 78

0 of 0 changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 96.533%

Totals
Change from base Build 72:	0.0%
Covered Lines:	278
Relevant Lines:	282

💛 - Coveralls

cmfcmf · 2018-08-07T13:42:10Z

I've written a bunch of docs now. I'd welcome a review :)

corinnaj

Great work! Thank you! I made some comments, most of which are nitpicking, but also some questions on parts I wasn't sure about.

corinnaj · 2018-08-07T22:43:30Z

README.md

-## About
+This project provides a microservice to manage gamification for your 
+application. It does not provide any graphics or pre-defined content, but 
+only a backend REST api. At its core, the service listens to events sent 


API is spelled in all caps

corinnaj · 2018-08-07T22:45:41Z

README.md

+- the user reached 10 XP
+- the user achieved the FooAchievement
+- a FooEvent is received
+


Maybe mention that a combination of rules can be required for an achievement. (e.g. user has 10 XP and FooAchievement)

corinnaj · 2018-08-07T22:54:56Z

README.md

+Each user has a level. The user starts at level 1 and can never go below that. 
+The level is strictly tied to the user's main xp "XP". The required xp for each 
+level can be configured to either be linearly increasing, exponentially 
+increasing,  or completely custom-defined. The level is not stored anywhere but 


Double space

corinnaj · 2018-08-07T22:57:43Z

README.md

+are granted, these are persisted to MongoDB. It is planned to also send an event
+back to RabbitMQ when an achievement or xp are granted.
+
+The gamification service also provides a (mostly) readonly REST api, which can


read-only instead of readonly

Huh. Must've used too much TypeScript lately 💃

corinnaj · 2018-08-07T22:59:08Z

README.md

+Define the different xp-pools there are within your application.
+The "XP" xp-pool is always defined.
+
+Note: This section is not yet used anywhere within the gamification service.


What do you mean here?

I've rewritten the paragraph to be more clear (I hope):

Note: The xp-pool names defined here are not currently validated by the
configuration parser, i.e. not specifying the available xp-pools or specifying
additional xp-pools does not raise an error currently. It is, however, planned
to validate the configuration more thoroughly, which would then raise an error
if you use an xp-pool not defined here.

Yes, that makes it clear to me. 👍

corinnaj · 2018-08-07T23:01:19Z

README.md

-You can send events manually in the *Exchanges* section. Select the exchange and then publish your message at *Publish message*. Don't forget to insert the *routing key*.
+Define when to increase a user's level based on their XP. The level is
+always purely based on the user's current XP. Each user, regardless of this
+configuration, always starts at level 0. That means that the first


Shouldn't this be Level 1?

corinnaj · 2018-08-07T23:14:22Z

README.md

+
+1. Achievements: The achievements service handles achievement data and stores
+granted achievements in the `achivements` collection. Each row consists of the
+`user_id`, the `name` (achievement name), `amount` (how often the user has


Shouldn't this be current_amount and total_amount? In other sections, you already talk about maxAwardedTotal, so the new values from your PR should also be included here.

corinnaj · 2018-08-07T23:15:39Z

README.md


-Simply run `npm test` and all your tests in the `test/` directory will be run.
+This project provides two `docker-compose` files, one meant for development and
+one meant for production. The 


The rest of this sentence is missing.

cmfcmf · 2018-08-08T07:24:32Z

Thank you for your remarks, @corinnaj! I don't think you were being too nit-picky. 😃 I've addressed them in 6f8a788.

I've cherry-picked this commit from #60, so that #60 is only about docs.

frederike-ramin

Really good job, thanks a lot, @cmfcmf!

cmfcmf changed the title ~~WIP: Cleanup README and LICENSE~~ Cleanup README and LICENSE Jul 19, 2018

corinnaj reviewed Jul 31, 2018

View reviewed changes

cmfcmf mentioned this pull request Aug 7, 2018

Add prefer-const ESLint rule #63

Merged

Cleanup license and README

630fcc1

cmfcmf force-pushed the chore/repo-cleanup branch from c87b77d to 630fcc1 Compare August 7, 2018 11:07

cmfcmf added 2 commits August 7, 2018 15:37

Write a bunch of documentation

f1ede80

Remove outdated documentation

5ecf850

cmfcmf changed the title ~~Cleanup README and LICENSE~~ Add documentation Aug 7, 2018

corinnaj reviewed Aug 7, 2018

View reviewed changes

Fix typos, remove trailing whitespace and address review comments

6f8a788

Phrasing/Wording/Typos up to AchievementRules

6e5e3aa

cmfcmf added a commit that referenced this pull request Aug 8, 2018

Add prefer-const ESLint rule (#63)

d148202

I've cherry-picked this commit from #60, so that #60 is only about docs.

corinnaj approved these changes Aug 9, 2018

View reviewed changes

Correct some small inaccuracies

c88e92a

frederike-ramin approved these changes Aug 14, 2018

View reviewed changes

Merge branch 'master' into chore/repo-cleanup

a0fa209

cmfcmf merged commit 9dfa3c5 into master Aug 18, 2018

cmfcmf deleted the chore/repo-cleanup branch August 18, 2018 20:00

cmfcmf mentioned this pull request Aug 18, 2018

Documentation #25

Closed

5 tasks

Add documentation #60

Add documentation #60

Uh oh!

Conversation

cmfcmf commented Jul 11, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

corinnaj Jul 31, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coveralls commented Aug 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 78

💛 - Coveralls

Uh oh!

cmfcmf commented Aug 7, 2018

Uh oh!

corinnaj left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cmfcmf commented Aug 8, 2018

Uh oh!

frederike-ramin left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

cmfcmf commented Jul 11, 2018 •

edited

Loading

corinnaj Jul 31, 2018 •

edited

Loading

coveralls commented Aug 7, 2018 •

edited

Loading