This repository has been archived by the owner on Aug 22, 2019. It is now read-only.
[Docs] - README.md - minor tweaks #1157
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
December 15, 2017 18:18
[Docs] - README.md - minor tweaks tweak number 1 - separators
fix number two - ortography (minor tweaks)
|
please tell me whether the correct word is learner or earner. please feel free to give me more feedback, as long as it is constructive |
|
now - adding tables of content - please don't merge yet |
adding Table of Contents (ToC)
|
now adding thumbnails |
adding thumbnail
|
i think it's everything for now |
auralon
reviewed
May 23, 2018
| ## What is the Backpack? | ||
|
|
||
| The Mozilla Backpack is a placed to store your collections of Open Badges. The Backpack allows earners to import badges and manage them in groups, choosing whether each group is public or not. You can access the Mozilla Backpack Web front-end at: http://backpack.openbadges.org | ||
|
|
||
| The Backpack code includes tools for badge issuers and displayers, for pushing awarded badges to an earner's Mozilla Backpack and for retrieving an earner's badges for display. If you're an issuer or displayer, you will find more information on how to start interacting with the Backpack at the bottom of this guide. | ||
| The Backpack code includes tools for badge issuers and displayers, for pushing awarded badges to an earner's Mozilla Backpack and for retrieving an earner's badges for display. If you're an issuer or displayed, you will find more information on how to start interacting with the Backpack at the bottom of this guide. |
There was a problem hiding this comment.
This should be displayer and not displayed
auralon
reviewed
May 23, 2018
| @@ -123,9 +143,9 @@ environment variable `NODE_ENV=production`. These differences include: | |||
|
|
|||
| Heroku relies upon the [habitat](https://github.com/brianloveswords/habitat) environment variables loader library. The config for this can be found in [lib/environments/heroku.js](lib/environments/heroku.js). | |||
|
|
|||
| When configuring your environment variables on heroku, they should be prefixed with the string that is passed to the habitat constructor. For example, if we pass the string "openbadges" to our habitat constructor, like so: `new Habitat("openbadges")`, then in heroku our protocol env var would be "OPENBADGES_PROTOCOL" (with, in this case, a value set to either http or https). | |||
| When configuring your environment variables on Heroku, they should be prefixed with the string that is passed to the habitat constructor. For example, if we pass the string "open badges" to our habitat constructor, like so: `new Habitat("open badges")`, then in Heroku our protocol env var would be "OPENBADGES_PROTOCOL" (with, in this case, a value set to either HTTP or https). | |||
There was a problem hiding this comment.
The string openbadges is acceptable and correct.
Also, if we uppercase HTTP we should probably uppercase HTTPS too.
auralon
reviewed
May 23, 2018
| ## I'm an Issuer, how do I use this? | ||
|
|
||
| The Backpack includes the following tools for badge issuers: | ||
|
|
||
| * [Issuer API](docs/apis/issuer_api.md) | ||
| * For pushing badges you have awarded the earner to their Mozilla Backpack, giving the earner the ability to approve the push through a lightboxed modal. The API is written in Javascript, and is includable in your project with just a few lines of JS. | ||
| * For pushing badges you have awarded the earner to their Mozilla Backpack, giving the learner the ability to approve the push through a lightbox modal. The API is written in Javascript, and is includable in your project with just a few lines of JS. |
There was a problem hiding this comment.
Earner is the correct term.
There was a problem hiding this comment.
"recipient"? https://openbadgespec.org/#recipient
There was a problem hiding this comment.
@ottonomy Yeah, that is even better! ;)
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[Docs] - README.md - minor tweaks
tweak number 1 - separators - adding separators before every single h2 tag (##)