From Fedora Project Wiki

(→‎Interested Persons: Added myself to list)
 
(46 intermediate revisions by 11 users not shown)
Line 1: Line 1:
= Fedora Open Badges =
= Fedora Open Badges =


The idea is that as you do things as a Fedora Contributor and (eventually) as a
With [https://badges.fedoraproject.org/ Fedora Badges], contributors to the Fedora project earn virtual badges for their
Fedora User, we'll automatically issue you badges saying "So and so filed their
work! The system automatically awards most badges based on [http://fedmsg.readthedocs.org/en/latest/ Fedmsgs] collected by
first bug in Bugzilla" or "So and so closed 10 bugs in one week!".
[https://github.com/fedora-infra/datanommer Datanommer]. After years of work, and many contributions from developers and artists, we have almost 400 badges implemented on [https://badges.fedoraproject.org/ Fedora Badges].


== Interested Persons ==
* [https://badges.fedoraproject.org/ Fedora Badges in production].
* [https://badges.stg.fedoraproject.org/ Fedora Badges in staging] (the badge aggregator is turned off for staging, so no new badges will be awarded here).
* [http://infrastructure.fedoraproject.org/infra/badges/rules/ Fedora Badges rules repo].
* Fedora Badges images files exist in each individual issue on [https://pagure.io/Fedora-Badges Pagure] and in [http://infrastructure.fedoraproject.org/infra/badges/pngs/ PNG] and [http://infrastructure.fedoraproject.org/infra/badges/svgs/ SVG] format.
* [https://github.com/oddshocks/presentations/tree/master/fedora_badges/build Oddshocks Flock presentation slides on Fedora Badges] (download and open index.html in your web browser)


* [[User:Ralph| Ralph Bean]]
== Documentation ==
* [[User: timjcasey| Tim Casey]]


A considerable amount of literature exists regarding this system:


If you think you want to know more about what we're trying to do here, you should probably jump on the [http://lists.fedoraproject.org/mailman/listinfo/badges mailing list] and add yourself to the above list.
* The readmes located in the repos of the various parts of the software stack, listed below under "Submitting Code".
* The [http://tahrir.readthedocs.org/en/latest/ brand-new RTFD pages] don't have much yet, but we're working on it!
* The [http://fedmsg.readthedocs.org/en/latest/ Fedmsg RTFD], on the other hand, has a wealth of information on that piece of the stack.
* Blog posts by [http://blog.linuxgrrl.com/2013/07/23/fedora-badgers/ mizmo].
* Blog posts by [https://riecatnor.wordpress.com/ riecatnor].
* Blog posts by [https://mashaleonova.wordpress.com/author/mleonova/ mleonova].


== Some unanswered questions ==
== Getting Involved ==


* What does the badge submission process look like? We have a brainstorm-y list started below... maybe a trac instance where people can submit tickets with their ideas and then community members with different skillsets can glom on and contribute the different necessary pieces (code.. image.. etc.)
Want to know more about what we're doing here? You can join the
[http://lists.fedoraproject.org/mailman/listinfo/badges mailing list].


* Who ultimately decides what badges we do and do not start handing out?  [[User:Ralph|threebean]]?
=== Submitting Badge Ideas ===


== Badge Ideas ==
You can submit and discuss ideas for potential badges on
[https://pagure.io/Fedora-Badges the Pagure page].
In order for a badge to be accepted, it must be fully-defined
via a YAML file and have associated artwork. A badge is accepted
when it receives 3 +1s from members of the badges-admin group.


Please add to the section below as you see fit; we're still in
Community badges may be defined by a simple paragraph explaining what the  
brainstorming mode.
badge is and what it is for. No YAML file is needed for these badges,
but art still is.


<pre>
=== Submitting Code ===
+ First                Submit your first package review
+ Reviewer              Complete your first package review of another individual
+ Push'd                Push your first update using bodhi
+ If you build it...    Complete your first successfull build with koji
+ SCM                  Push to the Fedora Package Repository
+ Proven                Provenpackager group
+ Sponsor              Packager sponsor group
+ Top packager          If you have more than X (20? 30?) packages approved
+ Reviewer              If you did more than X (10?) reviews


+ Bottom-poster        (doesn't top-post on email lists).
You can also contribute code to any part of the Badges stack:
+ Not a jerk            (awarded by steering committee for handling situations well)
+ Secretary General    (awarded when zodbot notes you as a chair in an IRC meeting)


+ Bug tracker          if you reported more than X (20? 30?) bugs
* [https://github.com/fedora-infra/fedmsg Fedmsg]
+ Alpha tester          if you reported X (1? 5? 10?) bugs against an alpha release
* [https://github.com/fedora-infra/datanommer Datanommer]
+ Beta tester          if you reported X (1? 5? 10?) bugs against a beta release
* [https://github.com/fedora-infra/fedbadges Fedbadges]
</pre>
* [https://github.com/fedora-infra/tahrir-api Tahrir-API]
* [https://github.com/fedora-infra/tahrir Tahrir]


=== Crazy Ideas ===
=== Submitting Badge Artwork ===


* Add a "Met User X" badge system. Use case: You're at a conference running a booth, everyone who comes up can scan your QR code and be awarded the "I met So and So in person" badge. This should be automatically available to anyone with a FAS account.
Fedora Badges is a perfect place to start if you want to help out the Fedora Design Team and the Badges project. Visit the [https://pagure.io/Fedora-Badges the Pagure page] and look for an issue that needs artwork. This [https://pagure.io/Fedora-Badges/issue/528 issue] holds the design resources you will need to design badges.
* Add an event badge system so that users can create badges for a particular event. "I went to FUDCon 2013"
 
* "I verified and signed $foos gpg key" ?
== Types of Badges ==
 
There are three major types of badges:
 
* Badges which are automatically awarded by the system.
* Badges which are awarded by users via an invitation (link and/or QR code).
* Badges which are awarded manually.
 
There are six categories of badges:
 
* Content/Learning
* Community
* Development
* Quality/Testing
* Events
* Miscellaneous
 
== Designing Badges ==
 
Designing Fedora Badges is a fun and artistic way to contribute to Fedora. With the help of many artists we have created almost 400 designs that are aesthetically cohesive.
 
=== Designing Fedora Badges: How To ===
 
'''1. Start by downloading the resources you will need to create Badge designs.'''
* [https://inkscape.org/en/download/ Inkscape].
* [https://pagure.io/Fedora-Badges/issue/528 Templates, Content & Palettes].
 
'''2. Familiarize yourself with the following links.'''
* [https://badges.fedoraproject.org/ Fedora Badges].
* [https://pagure.io/Fedora-Badges Fedora Badges Pagure page].
* Fedora Badges Style Guide
 
'''3. Choose an issue, and assign yourself as owner.'''  
* Once you have found an issue that you would like to make a design for, go to the [https://badges.fedoraproject.org/explore/badges Explore] page on Fedora Badges and research similar badges. What have other artists used to create their design? What background, what characters, colors, themes, etc?
 
'''4. Categorize your badge design. Is it:'''
* Content/Learning (Blue)
* Community (Pink)
* Development (Orange)
* Quality/Testing (Green)
* Event (Purple)
* Miscellaneous (Dark Blue)
 
This will be the outer ring color for your badge. Open the corresponding template, and save with your new file name. (Also, PSA, save your file early and often!!)
 
'''5. Choose a background color.'''
* Use the [https://badges.fedoraproject.org/explore/badges Explore] page to find similar badges and use the appropriate background color. 
* After you have chosen the background color, you will then either make it into a gradient, or you will overlay a pattern.  
* Try using one of the backgrounds that exist already, this helps keep our designs cohesive.
* If you have an idea for a full illustrated background, feel free to go for it!
 
'''6. Design badge graphics! You can do this in two ways:'''
* Create original designs
* Reuse/remix other badges designs
 
When creating graphics for Fedora Badges, keep these things in mind:
* Reference the style guide often. The style guide helps the many contributors work cohesive.
* Use a stroke of 1.5 or more on all of your objects, unless no stroke adds to the design
* If your design needs typography, use [https://fontlibrary.org/en/font/comfortaa Comfortaa]. Also use strokes to help the type pop off the background it is on.
* If your design requires the Fedora logo, do not skew the logo in any way, only resize it
 
'''7. Export your file, and upload to the issue.'''
* Make sure the export window in Inkscape says 256 x 256 for export size.
 
'''8. Request that a mentor review your badge artwork in #fedora-design on [https://webchat.freenode.net/ IRC].'''
* People you can ask for help with art: mizmo, riecatnor, sirko, mleonova
* Work with one of these mentors until they approve your art.
 
'''9. Once your artwork has been approved, add your name/badge issue to this [https://fedoraproject.org/wiki/Open_Badges/ArtworkLog wiki page].'''
* Also let riecatnor know to award you the appropriate badge!


== Really Making Badges ==
== Really Making Badges ==


Making a (phase one) badge requires the following:
Making a badge requires the following:


* Metadata
* Metadata.
** An image (with certain properties, TBD).
** A name.
** A name
** A description.
** A description
** An image which matches the criteria outlined in [http://blog.linuxgrrl.com/2013/07/23/fedora-badgers/ mizmo's awesome blog post].
** An http link to any old page describing criteria for the badge.
** An HTTP link to any old page describing criteria for the badge.
* Code
* A YAML description of the criteria for our fedmsg rules engine.
** A plugin for our infrastructure daemon that know when and when not to award badges. (we need some examples of how to write this)
** For examples, check out [http://infrastructure.fedoraproject.org/infra/badges/rules/ our rules repo].
** The [https://badges.fedoraproject.org/builder Fedora Badges badge builder] can help you write YAML files, but it is incomplete, and so can't really help you much with the trigger and criteria parts of the file.


== Infrastructure (the plan) ==
== Infrastructure ==


 
These badges get exported to Mozilla's Open Badges Infrastructure (OBI).  See
These will get exported to Mozilla's Open Badges Infrastructure (OBI).  See
their [http://openbadges.org/ frontpage] for a general introduction and
their [http://openbadges.org/en-US/ frontpage] for a general introduction and
[https://github.com/mozilla/openbadges#mozilla-open-badges the README] for a
[https://github.com/mozilla/openbadges#mozilla-open-badges the README] for a
more technical introduction.  This is good -- it means we don't lock in users'
more technical introduction.  This is good -- it means we don't lock in users'
badges just to Fedora where their friends' friends will never see them.
badges just to Fedora where their friends' friends will never see them.


Phase One badge awarding will be driven by the fedmsg bus.  For instance, when a
Epoch One badge awarding is driven by the fedmsg bus.  For instance, when a
user comments on a bodhi update, bodhi emits a fedmsg message.  A daemon sitting
user comments on a bodhi update, bodhi emits a fedmsg message.  A daemon sitting
in our infrastructure catches that message, checks a database[1] to see if that
in our infrastructure catches that message, checks a database[1] to see if that
user has ever comment on an update before.  If not, then a badge awarded to them
user has ever commented on an update before.  If not, then a badge is awarded to them
for commenting on their first update.  Badge awarding means creating an entry in
for commenting on their first update.  Badge awarding means creating an entry in
a second database that User X has Badge Y.
a second database that User X has Badge Y.
That process of checking the fedmsg database[1] is handled by a rules
engine.  Rules for badges are defined in a YAML format described above.


Mozilla's OBI requires that the user authenticate with them over
Mozilla's OBI requires that the user authenticate with them over
[http://www.mozilla.org/en-US/persona/ Persona].  We do not yet have a way to
[http://www.mozilla.org/en-US/persona/ Persona].  We do not yet have a way to
push badges automatically from our DB to the OBI. A stand-in workaround is to
push badges automatically from our DB to the OBI. A stand-in workaround is to
host a webapp that request Persona authn from the Fedora user and then exports
host a webapp that request Persona authn from the Fedora user and then exports
our badges to OBI over their json API.  This (while not deployed in our
our badges to OBI over their json API.  This actually works.. even if its a clumsy extra step.
infrastructure) actually works.. even if its a clumsy extra step.


Phase Two badge awarding will be driven by user activity on their Fedora
Epoch Two badge awarding will be driven by user activity on their Fedora
machine.  When they run yum update for the first time, or open the
machine.  When they run yum update for the first time, or open the
gnome-tweak-tool for the first time, a daemon on their machine will make
gnome-tweak-tool for the first time, a daemon on their machine will make
submissions to our infrastructure.. awarding them badges.  Phase Two is not yet
submissions to our infrastructure.. awarding them badges.  Epoch Two is not yet
well thought out.
well thought out.
== Opting Out of Badges ==
By default, all FAS accounts are included in the system.
By logging in to Tahrir, users can deactivate their accounts
and not earn any more badges. Their details will not be displayed
anywhere on their applications. This will apply until they log back
in and use the same button to reactivate their accounts.
In the future, we may implement more fine-grained control over
which parts of Badges you'd like to opt-out of.
== Resources ==
* [https://github.com/oddshocks/badges Oddshocks badges notes for his fedbadges internship].
* [https://fedoraproject.org/wiki/Fedora_RPG_OLD Old Fedora RPG sketches and mockups].
* [https://pagure.io/Fedora-Badges/issue/528 Design Resources].

Latest revision as of 11:13, 29 March 2017

Fedora Open Badges

With Fedora Badges, contributors to the Fedora project earn virtual badges for their work! The system automatically awards most badges based on Fedmsgs collected by Datanommer. After years of work, and many contributions from developers and artists, we have almost 400 badges implemented on Fedora Badges.

Documentation

A considerable amount of literature exists regarding this system:

  • The readmes located in the repos of the various parts of the software stack, listed below under "Submitting Code".
  • The brand-new RTFD pages don't have much yet, but we're working on it!
  • The Fedmsg RTFD, on the other hand, has a wealth of information on that piece of the stack.
  • Blog posts by mizmo.
  • Blog posts by riecatnor.
  • Blog posts by mleonova.

Getting Involved

Want to know more about what we're doing here? You can join the mailing list.

Submitting Badge Ideas

You can submit and discuss ideas for potential badges on the Pagure page. In order for a badge to be accepted, it must be fully-defined via a YAML file and have associated artwork. A badge is accepted when it receives 3 +1s from members of the badges-admin group.

Community badges may be defined by a simple paragraph explaining what the badge is and what it is for. No YAML file is needed for these badges, but art still is.

Submitting Code

You can also contribute code to any part of the Badges stack:

Submitting Badge Artwork

Fedora Badges is a perfect place to start if you want to help out the Fedora Design Team and the Badges project. Visit the the Pagure page and look for an issue that needs artwork. This issue holds the design resources you will need to design badges.

Types of Badges

There are three major types of badges:

  • Badges which are automatically awarded by the system.
  • Badges which are awarded by users via an invitation (link and/or QR code).
  • Badges which are awarded manually.

There are six categories of badges:

  • Content/Learning
  • Community
  • Development
  • Quality/Testing
  • Events
  • Miscellaneous

Designing Badges

Designing Fedora Badges is a fun and artistic way to contribute to Fedora. With the help of many artists we have created almost 400 designs that are aesthetically cohesive.

Designing Fedora Badges: How To

1. Start by downloading the resources you will need to create Badge designs.

2. Familiarize yourself with the following links.

3. Choose an issue, and assign yourself as owner.

  • Once you have found an issue that you would like to make a design for, go to the Explore page on Fedora Badges and research similar badges. What have other artists used to create their design? What background, what characters, colors, themes, etc?

4. Categorize your badge design. Is it:

  • Content/Learning (Blue)
  • Community (Pink)
  • Development (Orange)
  • Quality/Testing (Green)
  • Event (Purple)
  • Miscellaneous (Dark Blue)

This will be the outer ring color for your badge. Open the corresponding template, and save with your new file name. (Also, PSA, save your file early and often!!)

5. Choose a background color.

  • Use the Explore page to find similar badges and use the appropriate background color.
  • After you have chosen the background color, you will then either make it into a gradient, or you will overlay a pattern.
  • Try using one of the backgrounds that exist already, this helps keep our designs cohesive.
  • If you have an idea for a full illustrated background, feel free to go for it!

6. Design badge graphics! You can do this in two ways:

  • Create original designs
  • Reuse/remix other badges designs

When creating graphics for Fedora Badges, keep these things in mind:

  • Reference the style guide often. The style guide helps the many contributors work cohesive.
  • Use a stroke of 1.5 or more on all of your objects, unless no stroke adds to the design
  • If your design needs typography, use Comfortaa. Also use strokes to help the type pop off the background it is on.
  • If your design requires the Fedora logo, do not skew the logo in any way, only resize it

7. Export your file, and upload to the issue.

  • Make sure the export window in Inkscape says 256 x 256 for export size.

8. Request that a mentor review your badge artwork in #fedora-design on IRC.

  • People you can ask for help with art: mizmo, riecatnor, sirko, mleonova
  • Work with one of these mentors until they approve your art.

9. Once your artwork has been approved, add your name/badge issue to this wiki page.

  • Also let riecatnor know to award you the appropriate badge!

Really Making Badges

Making a badge requires the following:

  • Metadata.
    • A name.
    • A description.
    • An image which matches the criteria outlined in mizmo's awesome blog post.
    • An HTTP link to any old page describing criteria for the badge.
  • A YAML description of the criteria for our fedmsg rules engine.
    • For examples, check out our rules repo.
    • The Fedora Badges badge builder can help you write YAML files, but it is incomplete, and so can't really help you much with the trigger and criteria parts of the file.

Infrastructure

These badges get exported to Mozilla's Open Badges Infrastructure (OBI). See their frontpage for a general introduction and the README for a more technical introduction. This is good -- it means we don't lock in users' badges just to Fedora where their friends' friends will never see them.

Epoch One badge awarding is driven by the fedmsg bus. For instance, when a user comments on a bodhi update, bodhi emits a fedmsg message. A daemon sitting in our infrastructure catches that message, checks a database[1] to see if that user has ever commented on an update before. If not, then a badge is awarded to them for commenting on their first update. Badge awarding means creating an entry in a second database that User X has Badge Y.

That process of checking the fedmsg database[1] is handled by a rules engine. Rules for badges are defined in a YAML format described above.

Mozilla's OBI requires that the user authenticate with them over Persona. We do not yet have a way to push badges automatically from our DB to the OBI. A stand-in workaround is to host a webapp that request Persona authn from the Fedora user and then exports our badges to OBI over their json API. This actually works.. even if its a clumsy extra step.

Epoch Two badge awarding will be driven by user activity on their Fedora machine. When they run yum update for the first time, or open the gnome-tweak-tool for the first time, a daemon on their machine will make submissions to our infrastructure.. awarding them badges. Epoch Two is not yet well thought out.

Opting Out of Badges

By default, all FAS accounts are included in the system.

By logging in to Tahrir, users can deactivate their accounts and not earn any more badges. Their details will not be displayed anywhere on their applications. This will apply until they log back in and use the same button to reactivate their accounts.

In the future, we may implement more fine-grained control over which parts of Badges you'd like to opt-out of.


Resources