- 1 Fedora Open Badges
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.
- Fedora Badges in production.
- Fedora Badges in staging (the badge aggregator is turned off for staging, so no new badges will be awarded here).
- Fedora Badges rules repo.
- Fedora Badges images files exist in each individual issue on Pagure and in PNG and SVG format.
- Oddshocks Flock presentation slides on Fedora Badges (download and open index.html in your web browser)
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.
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.
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:
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:
- 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.
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 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 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.