From Fedora Project Wiki

m (typo)
(Designing Fedora Badges: How To)
 
(27 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
With [https://badges.fedoraproject.org/ Fedora Badges], contributors to the Fedora project earn virtual badges for their
 
With [https://badges.fedoraproject.org/ Fedora Badges], contributors to the Fedora project earn virtual badges for their
 
work! The system automatically awards most badges based on [http://fedmsg.readthedocs.org/en/latest/ Fedmsgs] collected by
 
work! The system automatically awards most badges based on [http://fedmsg.readthedocs.org/en/latest/ Fedmsgs] collected by
[https://github.com/fedora-infra/datanommer Datanommer]. Eventually, regular desktop users will earn badges, too.
+
[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].
  
 
* [https://badges.fedoraproject.org/ Fedora Badges in production].
 
* [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).
 
* [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].
 
* [http://infrastructure.fedoraproject.org/infra/badges/rules/ Fedora Badges rules repo].
* Fedora Badges images exist in [http://infrastructure.fedoraproject.org/infra/badges/pngs/ PNG] and [http://infrastructure.fedoraproject.org/infra/badges/svgs/ SVG] format. If the SVGs are not up-to-date, check [http://blog.linuxgrrl.com/2013/07/23/fedora-badgers/ mizmo's awesome blog post].
+
* 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)
 
* [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)
  
Line 15: Line 15:
 
A considerable amount of literature exists regarding this system:
 
A considerable amount of literature exists regarding this system:
  
* This wiki page. We're still working on updating it, but it's pretty good right now.
 
 
* The readmes located in the repos of the various parts of the software stack, listed below under "Submitting Code".
 
* 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://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.
+
* 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].
  
 
== Getting Involved ==
 
== Getting Involved ==
  
Want to know more about what we're doing here? You can join the (pretty quiet)
+
Want to know more about what we're doing here? You can join the
 
[http://lists.fedoraproject.org/mailman/listinfo/badges mailing list].
 
[http://lists.fedoraproject.org/mailman/listinfo/badges mailing list].
  
Line 28: Line 30:
  
 
You can submit and discuss ideas for potential badges on
 
You can submit and discuss ideas for potential badges on
[https://fedorahosted.org/fedora-badges/ the trac instance].
+
[https://pagure.io/Fedora-Badges the Pagure page].
 
In order for a badge to be accepted, it must be fully-defined
 
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
 
via a YAML file and have associated artwork. A badge is accepted
Line 36: Line 38:
 
badge is and what it is for. No YAML file is needed for these badges,
 
badge is and what it is for. No YAML file is needed for these badges,
 
but art still is.
 
but art still is.
 
In the future, we hope to have a fully-featured web application
 
where users can vote on badges and submit them via web form.
 
  
 
=== Submitting Code ===
 
=== Submitting Code ===
Line 49: Line 48:
 
* [https://github.com/fedora-infra/tahrir-api Tahrir-API]
 
* [https://github.com/fedora-infra/tahrir-api Tahrir-API]
 
* [https://github.com/fedora-infra/tahrir Tahrir]
 
* [https://github.com/fedora-infra/tahrir Tahrir]
 +
 +
=== 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 [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.
  
 
== Types of Badges ==
 
== Types of Badges ==
  
There are two major types of badges:
+
There are three major types of badges:
  
 
* Badges which are automatically awarded by the system.
 
* 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 by users via an invitation (link and/or QR code).
 +
* Badges which are awarded manually.
  
Badge borders are also color-coded even more specifically,
+
There are six categories of badges:
as detailed in [http://blog.linuxgrrl.com/2013/07/23/fedora-badgers/ mizmo's awesome blog post].
+
 
 +
* 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 ==
Line 84: Line 148:
 
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.
Line 105: Line 169:
 
== Opting Out of Badges ==
 
== Opting Out of Badges ==
  
By default, all FAS accounts are be included in the system.
+
By default, all FAS accounts are included in the system.
  
By logging in to Tahrir, the user can deactivate their account
+
By logging in to Tahrir, users can deactivate their accounts
 
and not earn any more badges. Their details will not be displayed
 
and not earn any more badges. Their details will not be displayed
anywhere on the application. This will apply until they log back
+
anywhere on their applications. This will apply until they log back
in and use the same button to reactivate their account.
+
in and use the same button to reactivate their accounts.
  
 
In the future, we may implement more fine-grained control over
 
In the future, we may implement more fine-grained control over
 
which parts of Badges you'd like to opt-out of.
 
which parts of Badges you'd like to opt-out of.
  
== Old Ideas ==
 
 
Before Fedora Badges became a reality, we had a list here of various ideas for badges.
 
For archival purposes (and perhaps future use), here are the ideas that have yet
 
to be implemented in some manner:
 
 
<pre>
 
+ First                Submit your first package review
 
+ Reviewer              Complete your first package review of another individual
 
+ SCM                  Push to the Fedora Package Repository
 
+ 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).
 
+ Not a jerk            (awarded by steering committee for handling situations well)
 
+ Generalissimo        Member of the Fedora Board, FPC or FESCo
 
+ Commander in Chief    Fedora Project Leader
 
 
+ Bug tracker          if you participated in more than X (20? 30?) bugs that have
 
                        been closed RAWHIDE, CURRENTRELEASE, or NEXTRELEASE
 
+ Alpha tester          if you reported X (1? 5? 10?) bugs against an alpha release
 
+ Beta tester          if you reported X (1? 5? 10?) bugs against a beta release
 
+ Living on the edge    Reported a bug against a Rawhide critpath package
 
 
+ Communicator          Submitted a translation to a Fedora package
 
+ Polyglot              Submitted two or more languages to a single Fedora package
 
 
+ Met $USER in person      Anyone can award this to anyone else.
 
+ Made $USER's day          Anyone can award this to anyone else.
 
+ Signed $USER's GPG key    Anyone can award this to anyone else.
 
 
+ Crème de la FEM          Awardable only by the Fedora Engineering Manager.
 
 
+ Fedora ♡ PyCon 2014      Awardable by people running the Fedora booth at PyCon 2014.
 
</pre>
 
  
 
== Resources ==
 
== Resources ==
Line 155: Line 184:
 
* [https://github.com/oddshocks/badges Oddshocks badges notes for his fedbadges internship].
 
* [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://fedoraproject.org/wiki/Fedora_RPG_OLD Old Fedora RPG sketches and mockups].
* [https://fedoraproject.org/wiki/Badges Old badges list].
+
* [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