Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🆕 📝 features: Add Team Profiles doc (closes #170) #180

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions exampleSite/content/features/team-profiles/_index.en.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
title: Team Profiles
description: Create profiles for Open Source companies and teams that showcase relevance to the SDGs and progress towards becoming a Digital Public Good.
categories: features
tags: ["content", "layouts", "unicef"]
downloadBtn: true

---
:toc:

The UNICEF Inventory theme includes a *Teams Profile* feature designed for the https://www.unicefinnovationfund.org/[UNICEF Venture Fund].
Team Profiles allow a site maintainer to create thematic groups of profiles that represent a team, company, or other organization that is building Open Source products that align to the United Nations Sustainable Development Goals.
Profiles using this layout will have a special appearance compared to other content published on the site.


[[motivation]]
== Feature motivation

The UNICEF Venture Fund works with many startup companies in an investment cohort.
Each thematic cohort can have anywhere from two to ten startup companies on average.
For all startup companies receiving investment from UNICEF, they have a requirement to seek recognition as a Digital Public Good (DPG).
Each company must meet all of the indicators of the Digital Public Good Standard to achieve recognition.

The Team Profiles feature is a profile tool to help UNICEF portfolio managers and startup company staff understand total progress in achieving the DPG Standard.
This provides a public, transparent evaluation of the Open Source work created by the startup company.
It provides a common, useful knowledge to multiple stakeholders, including the reviewer committee of the Digital Public Goods Alliance.


[[demo]]
== Demo: UNICEF Open Source Inventory

See this feature in action https://unicef.github.io/inventory/cohorts/[*on the UNICEF Open Source Inventory*].


[[config]]
== Profile configuration

See the front-matter of an example profile below:

.example-profile.md
[source,yaml]
----
---
title: FOSS in a Box
tags: ["data science", "financial inclusion"]
type: profiles

description: An example company for demonstration purposes.
country: Nepal
# usually the induction date of the cohort
date: 2022-08-30
github: https://github.com/example-fossbox
linkedin: https://www.linkedin.com/company/example-fossbox/
twitter: https://twitter.com/example-fossbox
website: https://example.com/
community: https://example.com/contact
# commit a logo to the same folder as the page
logo: example-fossbox.png
sdgs:
- 1
- 8
- 9
dpgs:
- 1
- 2
- 3
- 5
- 7
- 8
- 9

---
----


[[example]]
== Example: Rumsan Team Profile

[link=https://unicef.github.io/inventory/cohorts/blockchain/rumsan/]
image::example-team-profiles.png[Screenshot of the Rumsam Team Profile in the UNICEF Open Source Inventory.]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.