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

Design research into DPG report cards for UNICEF Venture Fund companies #1

Open
jwflory opened this issue Dec 29, 2021 · 2 comments
Open
Assignees
Labels
T: new change Adds new capabilities or functionality

Comments

@jwflory
Copy link
Member

jwflory commented Dec 29, 2021

Summary

Conduct a design exercise to prototype "DPG Report Cards" for UNICEF Venture Fund companies in a web app

Background

The Open Source Mentorship once made great use of these open source evaluation rubrics, but since moved away from them because they never found a good fit in the mentorship workflow, and frequently became out-of-date. Even though they are no longer used, there is also a gap in being able to quickly identify and assess where a given team is in their progress towards achieving the DPG Standard.

I remember a conversation with @lacabra where he mentioned the rubric was a helpful resource for him in the context of the DPG Alliance reviewing submissions from the Venture Fund. @Idadelveloper also put in a good amount of work to-date on the UNICEF Inventory Hugo theme. Combining these two pieces (i.e. a need for a quick assessment of Venture Fund portfolio companies, and a Hugo theme) seem like a possible solution to meeting this need.

Such a web application would benefit both the Venture Fund and the DPG Alliance:

  1. Venture Fund portfolio managers and team can quickly get the latest information about each team's progress in meeting the DPG Standard.
  2. Venture Fund mentors can contribute updates and data about each company's progress in meeting the indicators.
  3. Company is better equipped for the DPG application process by referring to their report card and converting the listed information into the form.
  4. DPGA reviewers have easier access to latest information about nominees coming from the UNICEF Venture Fund.
  5. Venture Fund and DPGA have better insight to the journey of Venture Fund companies in meeting the DPG Standard.

Details

To close this issue, the design process should complete these phases:

  1. Wire framing (done, see below)
  2. Prototype evaluation and feedback
  3. Architectural design and how to integrate cleanly into theme
  4. Code changes
  5. Site launch

Wire frame

See the six frames in the wire frame to understand the site design and look-and-feel:

UNICEF Coach Cards wire frame. There are six frames with the following titles: index, category, company page, report card, front matter template, hoverover on status.

Prototype

I created a fast prototype using Hugo the UNICEF Inventory theme, with a new layout added to the theme:

Screenshot of a report card for an existing Digital Public Good. Some values are changed for the purpose of demonstration.

Outcome

  • Faster assessments of UNICEF Venture Fund portfolio companies in their progress in reaching the DPG Standard
  • More efficient management of company status and updates (public and open to mentors, companies, and general public)

CC: @iperdomo @nathanbaleeta @nathanfletcher

@jwflory jwflory self-assigned this Dec 29, 2021
jwflory added a commit that referenced this issue Dec 29, 2021
This commit converts this conceptual repository into a prototype
project. This uses the Hugo static site generator to create a quick
website for evaluating and rating the performance of UNICEF portfolio
companies in a report card-like setting. It uses the UNICEF Inventory
Hugo theme to accomplish this.

Related to #1.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
@jwflory jwflory added the T: new change Adds new capabilities or functionality label Jan 4, 2022
@jwflory
Copy link
Member Author

jwflory commented Jan 5, 2022

Some feedback was shared in a Venture Fund team meeting this week:

  • Assigning a score: Could a company receive a single-number score or indicator of their progress? Ideally this would be at the top of the card and would be a summation of their results shown further down in the report.
  • Connecting to DPG infrastructure: Could these report cards be connected to the DPG nomination infrastructure? For example, could a Venture Fund start-up convert their completed report card into a completed DPG application?

@jwflory
Copy link
Member Author

jwflory commented Jan 6, 2022

Some feedback was shared in a Venture Fund mentor check-in call with @acabunoc and Philippa:

  • Cohort assessments: How much progress has a cohort made towards achieving DPG certification status? Some way to aggregate company progress for a cohort and offer quick visual comparisons, perhaps on the home page view.

jwflory added a commit to unicef/inventory-hugo-theme that referenced this issue Jan 12, 2022
This commit creates a new custom layout for DPG report cards in the
UNICEF Inventory theme. DPG report cards are at-a-glance views of a
Venture Fund company's progress in meeting the DPG Standard.

More context about this change is in unicef/coach#1. This commit should
be merged once the idea is validated and the early prototyping phase is
complete.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory-hugo-theme that referenced this issue Mar 11, 2022
This commit creates a new custom layout for DPG report cards in the
UNICEF Inventory theme. DPG report cards are at-a-glance views of a
Venture Fund company's progress in meeting the DPG Standard.

More context about this change is in unicef/coach#1. This commit should
be merged once the idea is validated and the early prototyping phase is
complete.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit to unicef/inventory-hugo-theme that referenced this issue Mar 11, 2022
This commit creates a new custom layout for DPG report cards in the
UNICEF Inventory theme. DPG report cards are at-a-glance views of a
Venture Fund company's progress in meeting the DPG Standard.

More context about this change is in unicef/coach#1. This commit should
be merged once the idea is validated and the early prototyping phase is
complete.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit that referenced this issue Mar 11, 2022
This commit converts this conceptual repository into a prototype
project. This uses the Hugo static site generator to create a quick
website for evaluating and rating the performance of UNICEF portfolio
companies in a report card-like setting. It uses the UNICEF Inventory
Hugo theme to accomplish this.

Related to #1.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: ci: Fix Shellcheck warnings in deploy script

Warnings identified by @iperdomo in PR #2.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:alembic: :wrench: ci: Use verbose HTML-Proofer error messages in logs

This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
jwflory added a commit that referenced this issue Mar 11, 2022
This commit converts this conceptual repository into a prototype
project. This uses the Hugo static site generator to create a quick
website for evaluating and rating the performance of UNICEF portfolio
companies in a report card-like setting. It uses the UNICEF Inventory
Hugo theme to accomplish this.

Related to #1.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: ci: Fix Shellcheck warnings in deploy script

Warnings identified by @iperdomo in PR #2.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:alembic: :wrench: ci: Use verbose HTML-Proofer error messages in logs

This commit updates the CircleCI Hugo orb to v1.3.0. This change
incorporates changes I made upstream in the Hugo orb so HTML-Proofer
will print verbose error messages if there is a failure. Currently,
error messages are suppressed in the CircleCI logs and this makes
debugging difficult. Additionally, the `asciidoc` binary is now included
in the container image used in this build, so specifying the Asciidoc
parameter in the CircleCI config is no longer necessary.

Related GitHub Pull Requests:

* CircleCI-Public/hugo-orb#47
* CircleCI-Public/hugo-orb#48
* CircleCI-Public/hugo-orb#50

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>
Neha9849 added a commit to Neha9849/inventory-hugo-theme that referenced this issue Jun 1, 2022
fixing the pdf view

minor fix

Update exampleSite/content/installation/elements/_index.en.md

Co-authored-by: Justin W. Flory <[email protected]>

:lipstick: layouts(navigation): Use consistent color on all pages (unicef#58)

This commit fixes a bug where the UNICEF Blue was hard-coded into the
navigation bar, and changes that hard-coded value to use the primary
color set by the site maintainer in the Hugo config file (`params.`
`primary_color`).

Additionally, I changed the color for the translations options to use a
white color, since it is hard to read when the primary color is a darker
color.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:new: :lipstick: layouts: Add dpg-report layout (see unicef/coach#1) (unicef#44)

This commit creates a new custom layout for DPG report cards in the
UNICEF Inventory theme. DPG report cards are at-a-glance views of a
Venture Fund company's progress in meeting the DPG Standard.

More context about this change is in unicef/coach#1. This commit should
be merged once the idea is validated and the early prototyping phase is
complete.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:new: :lipstick: layouts(shortcodes): Create table layout (unicef#70)

Shortcode for a table used in unicef/inventory#125.

:new: :sparkles: layouts(shortcodes): Add embed-pdf shortcode (unicef#56)

I have added a demo of this shortcode on the `installation/elements` page. For using this Shortcode, we have to pass the name of the pdf into the shortcode as shown in the demo. The pdfs should be stored in the `static/pdfs` folder.

Fixes unicef#33.

Co-authored-by: Justin W. Flory <[email protected]>

:bug: layouts(default): Add condition to show "RA Section" when content is available (unicef#68)

Fixes unicef#30.

* Add hugo condition to only show "RA Section" when there's content available
* Modify hugo conditions to check for available content before displaying the ra section
* Fix duplication of 'RA' section bug introduce by commit e4a8438
* Refactor hugo condition reposible for fixing the bugs in both issue unicef#30 and commit e4a8438
* Undo code refactoring introduced by commit 3f534dd

Co-authored-by: Zab <[email protected]>

:lipstick: assets(css): Make Table of Contents more appealing and responsive  (unicef#73)

* Complete the stated task
* Make table of contents more appealing and responsive
* Update template title
* Update layouts/partials/head.html

Commit emoji: https://gitmoji.dev/

Co-authored-by: Justin W. Flory <[email protected]>

🐛 assets(css): Fix styling of highlight code blocks (unicef#72)

* 🐛 fix: Improved styling of highlight code blocks
* Reduced whitespace between codelines using css
* 📝 docs: Added comment for CSS changes

:recycle: layouts(dpg-report): Reuse download-pdf partial (unicef#74)

The PDF download button logic was moved into a partial after this layout
was created. This refactors to use the partial and maintain less code.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: config: Removed Duplicate Home Link in Footer (unicef#80)

Fixes unicef#57.

In Footer partial, we have this:

```html
 <li><a class="nav-link text-white" href="{{ site.BaseURL | relLangURL }}">HOME</a></li>
        {{ range site.Menus.main }}
          {{if ne .Name "pages"}}
            <li class="nav-item">
              <a class="nav-link text-white text-uppercase" href="{{ .URL | absLangURL }}">{{ .Name }}</a>
            </li>
          {{ end }}
        {{ end }}
```

In all other upstreams, we don't have Home in the Menu array but we do have it in the exampleSite. This is what causes the duplication in exampleSite. So, I have removed it from the config file of the example site.

:bug: :memo: README: Fix link for example site config (unicef#82)

An example configuration used to be bundled at the top of the repo, but
now it is included as part of the example site used in building this
theme. This commit fixes the broken link in the README.

Closes unicef#79.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:bug: :wrench: ci: Fix GH Pages push with string comparison operator

This commit changes the string comparison operator for the git user name
in the deploy script used in continuous integration. Currently the check
is checking if the string is not empty, then it overrides what was set.
We actually wanted the inverse.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:new: :memo: .github: Add contributing guidelines (unicef#86)

* 🆕 📝 .github: Add contributing guidelines

This commit adds new contributing guidelines for the UNICEF Inventory
theme. It includes four main topics:

1. Contribution process (a.k.a. governance)
2. Conventions & courtesies
3. Structure & components
4. How to create a developer environment

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

* Address @Idadelveloper feedback in PR unicef#86; s/tickets/issues/

This commit makes a few changes, mostly coming from Ida's feedback in
Pull Request unicef#86:

1. Add a note about creating a git feature branch after being assigned
   an issue.
2. Add a note to tag an issue number in the commit message(s) of a Pull
   Request.
3. Change all mentions of "ticket" to "issue" to be more clear.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

💄 Admonitions: Standardize appearance and add new shortcodes (unicef#83)

* 💄 fix: Added CAUTION admonition shortcode (closes unicef#66)
* 💄 fix: Added IMPORTANT admonition shortcode (closes unicef#64)
* 💄 fix: Added admonition icons and updated docs

* Revert IDE changes to French localized file.

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

* Remove extraneous changes to index page

Signed-off-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

Co-authored-by: Justin W. Flory (he/him) [UNICEF Innovation] <[email protected]>

:lipstick: css: Highlight buttons on hovering (unicef#94)

Fixes unicef#90.

Type of Change:

- Code
- User Interface

📝 docs: Added table shortcode in elements page (unicef#96)

Fixes unicef#71.

This PR adds table shortcodes to the existing tables along with the documentation to the elements page.

added inventory layouts

 Added layouts of inventory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T: new change Adds new capabilities or functionality
Projects
None yet
Development

No branches or pull requests

1 participant