green-software-foundation / champions Goto Github PK

Hi @osamajandali

The PR went through the other day to change Pindy's city from Potters Bar to London
#26

This is updated and showing on her profile but not the main directory

@adamj89 to create

When @osamajandali is ready we can rename the repo.

Why: WE do NOT want people to mark themseleves as Experts on the markdown file, or manipulate the score or compute it manually, so we don't want that data to be present in th emarkdown
What: Discuss and implement solution that would provide an alternative data storage for each champion to hold the values for Expert flag, contribution score and others if necessary
Scope of work:

• Solution for storing the expert flag
• Solution for computing/storing the contribution score

Bug description: see build failure in https://github.com/Green-Software-Foundation/champions/actions/runs/7194308618

Is this a formatting issue again?

@zanete @osamajandali

@adamj89 to create

Why:
What: Clear instructions on how to reuse the speaker md files for creating a set of data files that store champion data in the new format

• The work can start on the 17th of October

Things to do ahead of this:

• review decision to go with md vs yaml - @osamajandali to let us know if there is an editor that would facilitate editing of md files with formatting etc
• Share the new md file template with the team - @osamajandali
• Create the forms for requesting additional contributions - @adamj89
• Create email copy for requesting additional contributions - @adamj89
• See if we can create an email alias/group and include Adam and Liene, to use for comms with champions - @adamj89

Scope of work:

• Provide a link to where the current speakers data is stored - @zanete https://drive.google.com/drive/folders/1KiQowDRzQj6qUPw5t3cFgqyaYGq_zLCY
• Provide a video for how to turn the old md file into the new file structure - @osamajandali as soon as confident the new md structure wont have any more tweaks
• Provide a folder where to store the new files - @zanete https://drive.google.com/drive/folders/1y8T7KBFisnvmJ-22phma4bje7xnpN4zm
• Describe how to count the points (manually) for the previous year only and flag Champaion candidates for experts
• Describe what data is missing and where to get it - @adamj89
• • Date of talks
• • Additional contributions (eg. emailing and asking them to fill details) + related email copy
• Provide link to the airtable where the contact data is stored - @adamj89
• (nice to have) Provide an overview of the process of updating the records (based on https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/70483980/Champions+-+Supabase+vs.+YAML)

• @LieneKal - Continue migrating the basic profiles to new md structure by 23rd
• @adamj89 - create an Activity submission form and ping @zanete for testing
• @adamj89 - Email the existing speakers to ask to update their information using the Update Profile form and the Activities form -with a deadline to submit by Monday the 23rd (form link: https://airtable.com/appyYf5kvFUBmA8Ts/shrtG32BVsx7JZ8IT)
• @zanete - submit activites on Asim's behalf
• @zanete - Hand the migrated md profiles to Osama - https://drive.google.com/drive/folders/1y8T7KBFisnvmJ-22phma4bje7xnpN4zm
• @osamajandali - to record a video for how to update the records by the 24th of October (including how to check out and commit, for total github dummies)
• @LieneKal - from the 25th, go through the updated profile records in AirTable: "Champions -> Profiles" and update the new md files and update the AirTable record to Committed to MD
• @LieneKal - from 25th, go through the activities records in AirTable: "Champions -> Activities" and add to the corresponding md file (based on the github name)
• @adamj89 / @zanete - calculate the Tentative activity score based on the activities added via AirTable

This is for the manual for Liene/Adam who will be taking records from AirTable and turning them into PRs for approval

• how to find / download the repository
• how to create a new branch
• how to make changes in VScode with a sample case
• how to commit
• how to make a pull request for merging into the master
• Make it so only Adam, Liene, Sophie (or Osama) can merge

Decision to use Airtable to administer point calculation and status of who has Champion or Expert status.

Airtable will read the markdown files to automatically calculate scores for each Champ/Expert

There will be a checkbox/switch to activate Champion or Expert status.

We need a number of badges to be created which people will attain for

[Adam to add proto]

Scope of work:

• find out if it is possible to add a linter to champions so that we would't have to rely on perfect formatting from a human being

@osamajandali Please can we change 2 of the links in the Champs header

Foundation Wiki >>> About
GSF Website >>> Homepage [link stays the same]

Lots of repetition, but good to get this fixed prior to launch.

Archive.zip
summary.pdf

Nearly 400 instances of - Elements must meet minimum color contrast ratio thresholds
60 instances of - Links must have discernible text
44 instances of - Images must have alternate text

From a quick review, lots of these seem to be coming from common places so it shouldn't be too difficult to fix up.

• Configure search to look at Name, Location (City, Country) and Organization
• try to enable so that [email protected] receives the Weekly Algolia Usage Reports

Hi @Jenya-design, we need a new logo to replace the Speakers project with Contributors

Existing logo is on speakers.greensoftware.foundation

• Location (Country)
• Activity Type
• Linked GSF Project

@adamj89 to compose full documentation for Champs Project

• - Project Overview
• - Adding a new profile
• - Editing existing profile
• - Adding activities
• - Removing Activity references (by request)
• - Project Approver guide for PR
• - Internal Manual

TBC

The following data fields for each champion

(Required) Activity type: one of the following values

• Speaking
• Writing
• Organizing
• Mentoring
• Hosting
• GSF Contribution
• GSF Project Leadership
• OSS Contribution

Profile

• (Required) GitHub Handle
• (Required) First Name
• (Required) Last Name
• (Required) Role
• (Required) Organisation
• (Required) Languages spoken
• (Optional) Pronoun
• (Required) City
• (Required) Country
• (Required) Biography
• (Optional) Profile Pic
• (Optional) Social media - Same as Speakers + website
• (Optional) Other notes

Activity history

Generic Activity Type"

• • (required) contribution type (speaking, writing etc)
• • (required) Linked GSF Project (dropdown list)
• • (optional) contribution-specific subtype (e.g. which Article type or Talk type) - for points, assume "Other" when not provided
• • (required) date from - used for sorting chronologically
• • (optional) date to (for a date range)
• (Optional) Related Event Name/Publication Title
• (required) Activity title
• (Optional) Activity Subtitle
• (optional) short description
• (required) URL

Speaking:

• (Required) Date
• (Required) Talk Type: Keynote | Conference Talk | Conference Demo | Meetup Talk | Lightning Talk | Online Demo | Online Talk | Internal Event Talk | Other
• (Required) Event Name
• (Required) Session Title
• (Required) Linked Project (dropdown list)
• (Optional) Subtitle
• (Optional) YouTube URL visualise in UI

Points for Speakers

Writing

• (Required) Date of Publication
• (Required) Article Type: Personal Blog Post | GSF Article | Company Article | 3rd Party Article | Other
• (Required) Where published
• (Required) Linked Project (dropdown list)
• (Required) Article name
• (Optional) Subtitle
• (Required) Link to article

Points for Articles

Organizing

• (Required) Date
• (Required) Type: Green Software Conference | Green Software Meetup | Internal Green Software Event | Online Event | Other
• (Required) Event Name
• (Optional) Subtitle
• (Required) Event Link
• (Required) Linked Project (dropdown list)

Points for Organizing

Mentoring

• (Required) Date Range
• (Required) Nature of Mentoring
• (Required) Linked Project (dropdown list)
• (Optional) Subtitle

Points for Mentoring

Hosting

• (Required) Date
• (Required) Event Name
• (Required) Linked Project (dropdown list)
• (Optional) Subtitle
• (Optional) Event Link

Points for Hosting

GSF Contribution

• (Required) Date
• (Required) Link to relevant issue
• (Required) Linked Project (dropdown list)
• (Optional) Subtitle
• (Optional) Additional Documentation

Points for GSF Contribution

GSF Project Leadership

• (Required) Date
• (Required) Type: WG Chair | Project Lead
• (Required) Linked Project (dropdown list)
• (Optional) Subtitle
• (Optional) Additional Documentation

Points for GSF Project Leadership

OSS Contribution

• (Required) Date
• (Required) Link to relevant issue
• (Required) Linked GSF Project (dropdown list)
• (Optional) Subtitle
• (Optional) Additional Documentation

Points for OSS Contribution

Experts Page. /experts/ page which JUST shows the experts in a list, one paragraph at the top, no filtering needed right now. They will also appear in the main directory but I want one page which I can send to people as a link also. Doesn't need to appear in the menu.

The actual implementation of the website
Scope of work:

• Create the new markdown structure
• Implement the champion listing
• Implement search
• update the file names to use github handle instead of full name
• Implement details page functionality based on the new structure
• Review & feedback
• remove the Contact Champion button from the profile page
• Remove the scroll from Filters
• Sort out top nav links: About -> Foundation Wiki: https://grnsft.org/wiki-pr-champions, Add "Experts" -> Takes to the experts page Remove "Directory", Remove "Apply", "Back to GSF" -> greensoftware.foundation
• Sort out the Green "Apply" button - New Champion account form ( https://grnsft.org/champions/new )
• Show new md field "subtitle" under the title of activity (this is an optional field)
• Show new md field "relatedEvent", just the value without the label to keep it generic, under the subtitle, above description (this is also an optional field)
• Hide the Experts toggle in the filters until further notice (not launching any experts yet)
• Grab latest MD files from https://drive.google.com/drive/folders/1y8T7KBFisnvmJ-22phma4bje7xnpN4zm
• Footer - @adamj89 to fill out
  I am looking for a champion
  I am a champion
  GitHub
  LEGAL
  Trademark Policy
  Privacy Policy
  Terms and Conditions
  GSF INFO
  Website
  Twitter
  LinkedIn

Note:

• filters is out of scope of this issue, will be in a separate issue #5

Why: The champions website is using the same data and people as the original speakers website but the format is new to support new functionality.
What: Migrate original speaker mds from https://github.com/Green-Software-Foundation/speakers/tree/main/src/pages/speakers to new champion md structures

Scope of work:

• Install VS Code
• Download all original speaker files from https://drive.google.com/drive/folders/1KiQowDRzQj6qUPw5t3cFgqyaYGq_zLCY
• Go through all the files in the tracker https://docs.google.com/spreadsheets/d/1ZTC4PbZJkspu8gIROJS7zoap7mcI-7sRXuO9h_FQLXo/edit#gid=0 and repeat the same thing for all:

This is to be repeated 84 times

• Create a new md file that uses the github username
• Copy all text from the sample new champion md template (that I sent via slack)

Look up the original speakers file and copy data into the new file as follows

• Split the name into first name / last name
• copy position to role
• copy company to organisation
• copy languages as is
• copy social as is
• copy bio as us (without quotes)
• add type: normal (not expert)
• copy location as is
• Tranform all Talks to activities
  contributionType: speaking
  subtype: look up the Talk type in https://github.com/orgs/Green-Software-Foundation/projects/2?pane=issue&itemId=37817656 (make lower case and substitute spaces with -)
  dateFrom: Follow link to talk to try and find the date
  dateTo: Follow link to talk to try and find the date
  title: copy as is
  description: Copy talk caption from URL if not too long.
  url: copy as is

https://github.com/Green-Software-Foundation/champions/actions/runs/6950336919
@osamajandali for investigation :)

To be started as soon as layout of the design is agreed as soon as #11 and #21 are finalised

Background: https://docs.google.com/document/d/1VGiacYFkcbjohXL9TskcrhCN7iS8zudl0gaE8iJOfS4/edit

Features required for the Contributors platform:
Getting data in there

1. As a contributor I would like to be able to add myself to the contributors platform (via Github)
2. As a Contributor I want to be able to add my contributions by specifying [date, type of contribution [speaking, organising, writing], activity (what I did)] - similar to https://mvp.microsoft.com/en-us/PublicProfile/5004204?fullName=Chris%20Lloyd-Jones
3. As a GSF team member I want to be notified that a contributor has added at least 4 contributions so that I could evaluate and mark them as recognised
4. As a contributor I would like to receive regular reminders to go and update my records in case information has changed

Browsing:

1. As a user I want to be able to see all details and contributors for a specific contributor

Filtering & Search (should use Algolia)

1. As a person who is looking for contributors I want to be able to find all writers
2. As a person who is looking for contributors I want to be able to find all people in Europe
3. As a person who is looking for contributors I want to be able to see what filtering options I have (preliminary: country, contribution type, experience level or ability to travel, all updates to see in the doc, + GSF Expert flag)

GSF Recognition

1. As a GSF team member I want to be able to evaluate contributors and mark them as "Recognised" (a flag)
2. As a user I want to see people who have been flagged as GSF Experts
3. As GSF team member I want the experts to be appearing at top of any lists / search results
4. As a GSF team member I don't want contributors to be able to mark them selves as "experts"
5. (phase 2) a dedicated site with JUST the experts