Merge pull request #217 from OpenRailAssociation/docs-badges

Add documentation for the use of badges

Author: cornelius

Diff for: docs/incubation/_index.md

@@ -19,3 +19,5 @@ The following guides describe activities on the various stages and how to advanc
 A project which is not longer active and maintained is formally retired:
 
 * [Retiring a project]({{< relref "retired" >}})
+
+To indicate the status of a project you can use the [OpenRail Project Badges]({{< relref "badges" >}}).

Diff for: docs/incubation/badges.md

@@ -0,0 +1,58 @@
+---
+weight: 1000
+---
+# Badges
+
+We provide a set of badges representing the status of projects in the OpenRail Association. They can be added to the README of a project and used in other locations where a quick visual indication that a project is part of the OpenRail Association or its stage in the incubation process is helpful.
+
+Badges are hosted as SVG files on the OpenRail website. Use the following snippets to add them to markdown files:
+
+## Incubation Stage 1
+
+    ![Badge Stage 1](https://openrailassociation.org/badges/openrail-project-stage-1.svg)
+
+Rendered result:
+
+![Badge Stage 1](https://openrailassociation.org/badges/openrail-project-stage-1.svg)
+
+## Incubation Stage 2
+
+    ![Badge Stage 2](https://openrailassociation.org/badges/openrail-project-stage-2.svg)
+
+Rendered result:
+
+![Badge Stage 2](https://openrailassociation.org/badges/openrail-project-stage-2.svg)
+
+## Incubation Stage 3
+
+    ![Badge Stage 3](https://openrailassociation.org/badges/openrail-project-stage-3.svg)
+
+Rendered result:
+
+![Badge Stage 3](https://openrailassociation.org/badges/openrail-project-stage-3.svg)
+
+## Incubation Stage 4
+
+    ![Badge Stage 4](https://openrailassociation.org/badges/openrail-project-stage-4.svg)
+
+Rendered result:
+
+![Badge Stage 4](https://openrailassociation.org/badges/openrail-project-stage-4.svg)
+
+## Administrative Projects
+
+    ![Badge Administrative](https://openrailassociation.org/badges/openrail-project-admin.svg)
+
+Rendered result:
+
+![Badge Administrative](https://openrailassociation.org/badges/openrail-project-admin.svg)
+
+## Sources
+
+The badges were initially rendered with https://shields.io:
+
+* Stage 1: https://img.shields.io/badge/OpenRail-Sandbox-peru
+* Stage 2: https://img.shields.io/badge/OpenRail-Incubation-silver
+* Stage 3: https://img.shields.io/badge/OpenRail-Graduated-gold
+* Stage 4: https://img.shields.io/badge/OpenRail-Retired-black
+* Administrative: https://img.shields.io/badge/OpenRail-Administrative-white