kavignon / fssf-mentorship-planner

SAFE application enabling F# developers to sign up and manage their application to the FSSF mentorship program.

Hi there 👋

My name is Kevin Avignon, and I am a senior software developer based in Montreal, Canada. I used to be a board member for the F# Software Foundation (FSSF). I led for 2 years the educative efforts for our international mentorship program and over that time, I had community members engaged with me as we built a platform to do match making between applicants (mentors/mentees).

You can find a list below of what I'm currently focused on:

• Exploring BEAM, Rails & Elm as I'm writing the online book Beware of Dragons

• I write posts on my technical blog from time to time.

  

fssf-mentorship-planner's Issues

Activate/Deactivating mentorship round

When activating a mentorship round, here are the expectations for the cloud system:

• Sends an email to a given mentor based on the HTML template from the mentorship email.
• Sends an email to a given mentee based on the HTML template from the mentorship email.
• Invites a given mentor to the private mentor channel in the FSSF Slack.

When deactivating a mentorship round, here are the expectation for the cloud system:

• Remove all added mentors from the current round from the private mentor channel
• Request users to provide their feedback for the given round and for the mentor/mentee

Ingest application logs with AWS CloudWatch

Add a landing page

On the landing page, we should quickly understand the project's goal and have a link that sends readers to the FSSF website.

From the landing page, users can:

• Sign in or Sign up
• Check their profile page
• Check the active round page
• Organizers can inspect the active round in admin mode

Allow admin users to create pairing with unmatched applicants in active round

In case an applicant doesn't show up or doesn't communicate with the other party, we can allow creating a new relationship from the pool of unmatched applicants for the given round as long as a match can be found or that there is consent between the 2 parties.

Setup an AWS RDS

In the free tiers of AWS, let's set up a database that can support the needs of the application such as:

• Persisting the profiles of the applicants and the organizers,
• Persisting the history of the rounds,
• Persisting the supported F# topics that can be found in a mentorship round,
• Persisting the feedback on applicants

Deploy the website on AWS

For the MVP, let's simply select the free tiers of Azure, and we can worry about custom domains, should the need arise, in the future.

Display the mentorship active round on the landing page

Add the functionality of pairing a mentor to a mentee

When pairing a mentor to mentee, there are a few things that should be kept in mind:

• There are skills that are rarer to find in a given mentorship round such as machine learning with F#. A pairing for a rarer skill has more weight than a pairing for a skill that's popular such as being introduced to F#. We can simply measure the frequency of applications per topic and provide more weight to the topics that have far less demand.
• We suggest that mentors start supporting more than one mentee after they've completed a round of mentoring before with a single student.
• A mentor cannot teach to 2+ mentees at the same time. It's possible to teach on Monday from 6 to 7.30 pm and then 8 to 10 pm or have different mentoring sessions on different weekdays.
• A pairing between a mentor and a mentee will be considered only if there's a match in for their topics of interest in F# and they have an overlap in their availabilities
• The more hours applicants have in common, the easier it'll be to find a time to meet and therefore, the stronger the relationship between the 2 parties.

Add applicant sign up page

On the signup page for applicants, we want to make sure to capture the following information:

• Their full name
• Their Slack username in the FSSF Slack
• Their email address
• Their password for their account

Add applicant enrollment page

On this page, we want to capture the given information:

• Their timezone for the given round (this could change from round to round if they go on a trip or relocate)
• Their F# topic(s) that they're looking to learn/work on during the round
• Their weekly schedule during the mentorship round
• Whether they are a mentee or mentor or both
• For mentors, how many mentees they are willing to support and which topic per mentee

Add the login page

Handle user management with Auth0

Add the admin page to view active status of the mentorship round

On this page, admins (the mentorship organizer(s)) can do the following:

• See a chart that shows the number of mentors and the number of mentees
• Breakdown the list of applicants by mentors/mentees/F# topic/timezone
• See an estimation of how many pairings can be created for the active round based on the current data
• Create a temporary list of pairings based on the applicant pool
• Lock the list of pairings and activate the mentorship round

Create the Docker image for the FSSF Mentorship application

Being a SAFE application, both backend and frontend are F# projects under the same .NET solution. A single image should suffice. Let's make sure that have support for HTTPS.

Create the GitHub Action configuration for the project

Everything related to the project will be handled in the repository, such as building, testing, package, and deploying the application to the cloud provider (Azure).

Let's start with something simple for an initial version and go from there.

• Restore the development dependencies
• Build the solution
• Test the solution
• Build the Docker image
• Deploy Docker image to AWS
• Add support for Windows and Linux machines