SoK/Administer the SoK: Difference between revisions

From KDE Community Wiki
< SoK
(Created page with "This page is an informal guide on how to admin a SoK based on SoK 2022. There are some durations to help you know how much time it can take. = Preparation of the SoK = * Gath...")
 
(Added external links (mentorship website, invent, mailing lists))
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This page is an informal guide on how to admin a SoK based on SoK 2022. There are some durations to help you know how much time it can take.
Administer an event can seem complicated even more when there is no guide about it.
This page tries to be an informal guide on helping you discover what are the necessary steps to admin a SoK based on SoK 2022 experience.


= Preparation of the SoK =
== Creation of the event (around 1 or 2 months before the event) ==
* Gather admins (at least 2) and send a mail to KDE community <[email protected]> around 1 month before the event (something like https://mail.kde.org/pipermail/kde-community/2021q4/007116.html)
* Gather admins (at least 2) and send a mail to [mailto:[email protected] KDE community] (something like https://mail.kde.org/pipermail/kde-community/2021q4/007116.html).
* Create https://community.kde.org/SoK ideas page for your year (copy the previous one, clean the ideas) (~1 hour)
 
Subscribe to https://mail.kde.org/mailman/listinfo/kde-soc-management (~10 minutes)
== Preparation of the event ==
* Ask admin access to https://season.kde.org/ to kde-soc-management mailing list (~1 hour to send a mail) and create a new season for your year (~1 hour)
* Create https://community.kde.org/SoK ideas page for this year (copy the previous one, clean the ideas).
* Make a MR to update the season of kde website ideas page in the introduction: https://invent.kde.org/websites/season-kde-org/-/commit/d6551083864241c34d4fc35807b84007f42915ed
* Subscribe to https://mail.kde.org/mailman/listinfo/kde-soc-management.
* Update the timeline with something like: (~2 hours to count good)
* Ask admin access to https://season.kde.org/ to kde-soc-management mailing list.
     T0: announcement date of SoK (mail of next step sent)
* Create a new season for your year once you have access.
     T1 = T0 + 1 month mentor/student applications deadline,
* Make a MR to update the season of kde website ideas page in the introduction: https://invent.kde.org/websites/season-kde-org/-/commit/d6551083864241c34d4fc35807b84007f42915ed.
* Update the timeline with something like:
<pre>
     T0: announcement date of SoK
     T1 = T0 + 1 month mentor/contributor applications deadline
     T2 = T1 + 1 week: announce the projects
     T2 = T1 + 1 week: announce the projects
     T3 = T2 + 2 days: start of work
     T3 = T2 + 2 days: start of work
Line 15: Line 20:
     T5 = T4 + 3 days: results announcements
     T5 = T4 + 3 days: results announcements
     T6 = T5 + 1 month: certificates issued + shipping of the swag/merchandise
     T6 = T5 + 1 month: certificates issued + shipping of the swag/merchandise
</pre>


* Send a mail to write the ideas in the wiki. Mail example (update the years): (~2 hours if you want to customize the mail)
== Gathering of the ideas ==
```
* Send a mail for the potential mentors to write the ideas in the wiki. A mail example is https://mail.kde.org/pipermail/kde-community/2021q4/007141.html and needs to be send to the [mailto:[email protected],[email protected],[email protected],[email protected],[email protected],[email protected],[email protected] KDE soc mentors, community, devel, core-devel, edu, games, soc mailing lists].
To: Kde Soc Mentor <[email protected]>, KDE community <[email protected]>, kde-devel <[email protected]>, kde-core-devel <[email protected]>, [email protected], [email protected]
* Also communicate it in the [https://webchat.kde.org/#/room/%23kde-soc:kde.org kde-soc Matrix channel] where potential contributors should be.


Subject:  
== Promote the event ==
Season of KDE 2022 Ideas page skeleton is live
* As soon as we know the SoK will take place, we need to prepare a blog post and communication to ensure we reach as much as good potential contributors as we can. Ask Promo (https://webchat.kde.org/#/room/#kde-promo:kde.org) to promote the event! Something like [https://dot.kde.org/2017/11/19/announcing-season-kde-2018 2018], [https://dot.kde.org/2019/11/29/announcing-season-kde-2020 2020] announcements.


Body:
== Inform on how to register ==
Hi,
=== As a contributor ===
The expected timeline can be found at https://season.kde.org/.
* Send a mail to all potential contributors to enter their application with the subject: "The contributors are supposed to create the project themselves after contacting their potential mentors and discussing with them. Generally we also expect from the contributor to write a bigger text than the one in the idea page."
https://community.kde.org/SoK/Ideas/2022 is live, as a skeleton to write down your ideas.
* Send a kind reminder two weeks before the deadline ([https://mail.kde.org/pipermail/kde-community/2021q4/007143.html example] and [https://mail.kde.org/pipermail/kde-community/2021q4/007144.html a fix of a mistake] in the previous mail).
If you are adding an idea, please remember to put your own contact information in the
* It is up to the contributors to create the project themselves in the website after contacting their potential mentors and discussing with them. Generally we also expect from the contributor to write a bigger text than the one in the idea page.
description as the mentor. Do not add Ideas with no mentor and contact
info.


Remember that SoK is more general than GSoC, so these ideas are
=== As a mentor ===
not limited only to coding tasks and you can include projects related to
Check [https://mail.kde.org/mailman/private/kde-soc-mentor/2023-January/005125.html this email] as reference:
documentation, artwork, translation, reports and other types of work as
* Send the mail to tell to register to the app, and select the project they want to mentor.
well as code.
* As admin, go to the mentor application page from time to time to approve mentors only if they are listed on the SoK ideas list or if you are sure they are "long-term" contributors (do not accept anyone if you are not sure they are a mentor).
* Do not assign mentors to a project, it is up to the mentors to do it.


Cheers,
== Once applications deadline is passed ==
* Ask mentors to mentor for the projects they are willing to mentor and that they don't wait the last moment to do it.


SoK Admin team
== The day of accepted projects ==
```
* Accept the proposals which have mentors.
* Create the status report page for this year if it does not exist yet: https://community.kde.org/SoK/2022/StatusReport.
* Send a welcome mail including to ask for reports from contributors: https://mail.kde.org/pipermail/kde-soc/2022-January/001594.html and ask promo if they can do an article on dot.kde.org with selected projects (it is best to help them by providing the content with all selected projects).
* Don't forget to also send a mail to all contributors that were not accepted to explain that they can still contribute outside SoK and it does not have to be the end their journey within KDE.


* Ask Promo (https://webchat.kde.org/*/room/*kde-promo:kde.org) to promote the event! (~ 2 hours to write the article). Something like https://dot.kde.org/2017/11/19/announcing-season-kde-2018 and https://dot.kde.org/2019/11/29/announcing-season-kde-2020.
== During the SoK ==
* Ask willing contributors to write blog posts about their progress and publish it in the [https://planet.kde.org/ planet.kde.org feed]([https://invent.kde.org/websites/planet-kde-org/ Git project]). In all cases, they have to write regularly their status reports.
* There is no mid-term evaluations but if mentors/contributors need to, they can stop at anytime but they need to inform the kde-soc-management team.
* Be present in the [https://webchat.kde.org/#/room/%23kde-soc:kde.org kde-soc Matrix channel] in case there are questions.


* Send a mail to all potential students to enter their application with the subject: "The students are supposed to create the project themselves after contacting their potential mentors and discussing with them. Generally we also expect from the student to write a bigger text than the one in the idea page."
== End of work ==
* Once the end of work target is reached, mentors have around one week to mark the projects as completed. To do so, go to the project page at https://season.kde.org, where there will be a new box "Feedback" with a checkbox "Completed" and a Submit button.
* Submit a short summary of the project for a wrap-up blog post about the different projects and their status (see, e.g., https://dot.kde.org/2022/05/03/season-kde-2022-conclusion).


* Send a kind reminder two weeks before the deadline. (~ 2 hours to write the article)
== After results announced ==
* Generate the certificates for each contributor: [https://invent.kde.org/apol/sok-certificates Git repository].
* Optionally, you can update the background image when it's become "too" old (or ask in [https://krita-artists.org/t/new-certificate-background-for-season-of-kde/39623 krita-artists] if anyone is willing to help create a new one).
* Usually, we go with [https://www.freewear.org/ FreeWear] ([mailto:[email protected] contact]) for customising the goodies. Feel free to contact the [mailto:[email protected] Visual Design Group] if you need help with the design!
* With the KDE e.V., discuss the budget for the SoK goodies to be sure we ask a quotation that fits.
* Gather information for every contributor who wants to get the swag. Namely:
<pre>
  - Project name
  - Real name
  - email
  - Phone number
  - Postal Address
  - T-Shirt size and fit
</pre>


* It is up to the students to create the project themselves after contacting their potential mentors and discussing with them. Generally we also expect from the student to write a bigger text than the one in the idea page." to the season.kde.org website
== Improvement ideas/questions ==
Some suggestion/feedback from SoK 2022/2023.


* Go to the mentor application page from time to time to approve mentors only if they are listed on the SoK ideas list or if you are sure they are "long-term" contributors (do not accept anyone if you are not sure they are a mentor)
''Communication''
* ''More communication and sooner'': SoK 2022 felt a bit rushed for everybody, mentors didn't have the time to polish their ideas, promo didn't have the time to promote the event before it started, contributors didn't have enough time to prepare their proposals as the SoK was announced late.
* ''Deadlines'': Have deadlines for mentor proposals come first, with the deadline for contributor proposals later. Or have only one deadline renamed "Deadline for SoK proposals". The way it is currently presented in the timeline is confusing. 
* ''Announcement'': Make clear that SoK is not only for developers, but also for graphic artists, translators(?), documentation writers, etc.
* ''Terminology'': Be consistent in terms used (e.g., students or mentees).
* ''Promotion'': Contact or interview former SoK mentees to collect materials for attracting potential new contributors.
* ''Contributor development'': Position SoK as a possible first step in contributor development, something like: Step 1 SoK mentee -> Step 2 submit GSoC application -> Step 3 mentor an SoK project.


* Don't assign mentors to a project, it is up to the mentors to do it.
''For mentors''
 
* ''Attracting mentors'': Provide information about why mentoring can be interesting and valuable for a project.
= Once applications deadline is passed =
* ''Training'': Hold a "mentor-the-mentors" workshop with old and new mentors to share strategies and brainstorm ideas for the coming year. This will also clarify expectations and align mentors across projects. Additionally, this also be a time to decide who does what and when (e.g., issuing the certificates, organizing swag, writing the final summary post).
* Ask mentors to mentor for the projects they are willing to mentor.
 
= The day before the acceptation of the projects =
* Accept the proposals which have mentors.


= The day of accepted projects =
''For mentees''
* Create the status report page for this year: https://community.kde.org/SoK/2022/StatusReport
* ''Defining success'': Clarify what will result in passing/failing SoK.
* ''Defining expectations'': Provide information early on about what is expected during SoK (e.g., status reports, blog posts, etc.)


* send a welcome mail including to ask for reports from students : https://mail.kde.org/pipermail/kde-soc/2021-February/001585.html (previous link) + article on dot.kde.org with selected projects
== FAQ ==
===Is there a hardcoded limit for postuling, editing proposals...?===
Nothing limits anything in the code but it is better to stick to the deadlines.


= After the SoK =
===What's the difference between "Accepted" and "Mentors"?===
* Create the certificates for each student: https://invent.kde.org/apol/sok-certificates
Mentors need to put themselves as mentors before the announcement of the selected projects. The project will be accepted when it is announced.


* Usually, we go with http://freewear.org/ (mail: [email protected]) for customising the goodies.  Feel free to contact the (VDG)[[email protected]] if you need help with the design!
== External links ==


With the KDE e.V., discuss the budget for the SoK goodies to be sure we ask a quotation that fits.
[https://mentorship.kde.org/ KDE's Mentorship Website]


- Gather information for every student who wants to get the swag. Namely:
[https://invent.kde.org/teams/season-of-kde Season of KDE at Invent]
  * Project name
  * Real name
  * email
  * Phone number
  * Postal Address
  * T-Shirt size and fit


* Write a blog post about the different projects and their status
[https://mail.kde.org/mailman/listinfo/kde-soc KDE-Soc (KDE student mailing list)]


= FAQ =
[https://mail.kde.org/mailman/listinfo/kde-soc-mentor KDE-Soc-Mentor (KDE mentor mailing list)]
* Is there a hardcoded limit for postuling, editing proposals...?
-> Nothing limits anything in the code but it is better to stick to the deadlines.


* What's the difference between "Accepted" and "Mentors"?
[https://mail.kde.org/mailman/listinfo/kde-soc-management KDE-Soc-Management (KDE admin mailing list)]
-> Mentors need to put themselves as mentors before the announcement of the selected projects. The project will be accepted when it is announced.

Latest revision as of 15:59, 12 December 2023

Administer an event can seem complicated even more when there is no guide about it. This page tries to be an informal guide on helping you discover what are the necessary steps to admin a SoK based on SoK 2022 experience.

Creation of the event (around 1 or 2 months before the event)

Preparation of the event

    T0: announcement date of SoK
    T1 = T0 + 1 month mentor/contributor applications deadline
    T2 = T1 + 1 week: announce the projects
    T3 = T2 + 2 days: start of work
    T4 = T3 + 3 months; end of work
    T5 = T4 + 3 days: results announcements
    T6 = T5 + 1 month: certificates issued + shipping of the swag/merchandise

Gathering of the ideas

Promote the event

  • As soon as we know the SoK will take place, we need to prepare a blog post and communication to ensure we reach as much as good potential contributors as we can. Ask Promo (https://webchat.kde.org/#/room/#kde-promo:kde.org) to promote the event! Something like 2018, 2020 announcements.

Inform on how to register

As a contributor

  • Send a mail to all potential contributors to enter their application with the subject: "The contributors are supposed to create the project themselves after contacting their potential mentors and discussing with them. Generally we also expect from the contributor to write a bigger text than the one in the idea page."
  • Send a kind reminder two weeks before the deadline (example and a fix of a mistake in the previous mail).
  • It is up to the contributors to create the project themselves in the website after contacting their potential mentors and discussing with them. Generally we also expect from the contributor to write a bigger text than the one in the idea page.

As a mentor

Check this email as reference:

  • Send the mail to tell to register to the app, and select the project they want to mentor.
  • As admin, go to the mentor application page from time to time to approve mentors only if they are listed on the SoK ideas list or if you are sure they are "long-term" contributors (do not accept anyone if you are not sure they are a mentor).
  • Do not assign mentors to a project, it is up to the mentors to do it.

Once applications deadline is passed

  • Ask mentors to mentor for the projects they are willing to mentor and that they don't wait the last moment to do it.

The day of accepted projects

  • Accept the proposals which have mentors.
  • Create the status report page for this year if it does not exist yet: https://community.kde.org/SoK/2022/StatusReport.
  • Send a welcome mail including to ask for reports from contributors: https://mail.kde.org/pipermail/kde-soc/2022-January/001594.html and ask promo if they can do an article on dot.kde.org with selected projects (it is best to help them by providing the content with all selected projects).
  • Don't forget to also send a mail to all contributors that were not accepted to explain that they can still contribute outside SoK and it does not have to be the end their journey within KDE.

During the SoK

  • Ask willing contributors to write blog posts about their progress and publish it in the planet.kde.org feed(Git project). In all cases, they have to write regularly their status reports.
  • There is no mid-term evaluations but if mentors/contributors need to, they can stop at anytime but they need to inform the kde-soc-management team.
  • Be present in the kde-soc Matrix channel in case there are questions.

End of work

  • Once the end of work target is reached, mentors have around one week to mark the projects as completed. To do so, go to the project page at https://season.kde.org, where there will be a new box "Feedback" with a checkbox "Completed" and a Submit button.
  • Submit a short summary of the project for a wrap-up blog post about the different projects and their status (see, e.g., https://dot.kde.org/2022/05/03/season-kde-2022-conclusion).

After results announced

  • Generate the certificates for each contributor: Git repository.
  • Optionally, you can update the background image when it's become "too" old (or ask in krita-artists if anyone is willing to help create a new one).
  • Usually, we go with FreeWear (contact) for customising the goodies. Feel free to contact the Visual Design Group if you need help with the design!
  • With the KDE e.V., discuss the budget for the SoK goodies to be sure we ask a quotation that fits.
  • Gather information for every contributor who wants to get the swag. Namely:
  - Project name
  - Real name
  - email
  - Phone number
  - Postal Address
  - T-Shirt size and fit

Improvement ideas/questions

Some suggestion/feedback from SoK 2022/2023.

Communication

  • More communication and sooner: SoK 2022 felt a bit rushed for everybody, mentors didn't have the time to polish their ideas, promo didn't have the time to promote the event before it started, contributors didn't have enough time to prepare their proposals as the SoK was announced late.
  • Deadlines: Have deadlines for mentor proposals come first, with the deadline for contributor proposals later. Or have only one deadline renamed "Deadline for SoK proposals". The way it is currently presented in the timeline is confusing.
  • Announcement: Make clear that SoK is not only for developers, but also for graphic artists, translators(?), documentation writers, etc.
  • Terminology: Be consistent in terms used (e.g., students or mentees).
  • Promotion: Contact or interview former SoK mentees to collect materials for attracting potential new contributors.
  • Contributor development: Position SoK as a possible first step in contributor development, something like: Step 1 SoK mentee -> Step 2 submit GSoC application -> Step 3 mentor an SoK project.

For mentors

  • Attracting mentors: Provide information about why mentoring can be interesting and valuable for a project.
  • Training: Hold a "mentor-the-mentors" workshop with old and new mentors to share strategies and brainstorm ideas for the coming year. This will also clarify expectations and align mentors across projects. Additionally, this also be a time to decide who does what and when (e.g., issuing the certificates, organizing swag, writing the final summary post).

For mentees

  • Defining success: Clarify what will result in passing/failing SoK.
  • Defining expectations: Provide information early on about what is expected during SoK (e.g., status reports, blog posts, etc.)

FAQ

Is there a hardcoded limit for postuling, editing proposals...?

Nothing limits anything in the code but it is better to stick to the deadlines.

What's the difference between "Accepted" and "Mentors"?

Mentors need to put themselves as mentors before the announcement of the selected projects. The project will be accepted when it is announced.

External links

KDE's Mentorship Website

Season of KDE at Invent

KDE-Soc (KDE student mailing list)

KDE-Soc-Mentor (KDE mentor mailing list)

KDE-Soc-Management (KDE admin mailing list)