GSoD: Difference between revisions

← Older edit

Latest revision as of 16:01, 26 March 2021

About Season of Docs

All students and developers are welcome to participate in the Summer of Documentation program with KDE. Here's how.

Key Information

Communication

1) The official KDE channel for Season of Docs: https://webchat.kde.org/#/room/%23kde-sod:kde.org

2) Google has two groups that all interested parties - admins, mentors, and technical writers - should join:

one for announcements: https://groups.google.com/forum/#!forum/season-of-docs-announce

and one for discussions: https://groups.google.com/forum/#!forum/season-of-docs-discuss

3) There is also a Slack channel for Season of Docs, which you can join by clicking the invitation link on the official program page

Dates

Organization applications start on February 9, 2021. The deadline for KDE to apply as an organization is March 26, 2021 at 18:00 UTC

Google will announce which organizations have been accepted into the program on April 16, 2021 at 18:00 UTC.

Technical writer hiring deadline on May 17, 2021

Full Season of Docs timeline: https://developers.google.com/season-of-docs/docs/timeline

How to contact us

We have three 4 ideas that can be found on the proposal page and are offered by two teams.

If you are interested in contributing to the Kirigami proposal, you can go to the Matrix #kirigami:kde.org or directly contact the mentor on Matrix @carl:kde.org or by mail carl at carlschwan.eu.

If you are interested in contributing to the Uyuni Project project you can contact find all the contact information on that page

@@ Line 1: / Line 1: @@
-{{Construction}}
 [[Category:Mentoring]]
 == About Season of Docs ==
+All students and developers are welcome to participate in the Summer of Documentation program with KDE. Here's how.
-'''This is the central page for organizing KDE's participation in Season of Docs 2019. If you would like to create additional pages, please make them as subpages of this page.'''
 === Key Information ===
@@ Line 22: / Line 19: @@
 ) There is also a Slack channel for Season of Docs, which you can join by clicking the invitation link on [https://developers.google.com/season-of-docs/docs/discussion the official program page]
+-----
------
 '''Dates'''
-* Organization applications start on April 2, 2019 at 20:00 UTC. '''The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.'''
+* Organization applications start on February 9, 2021. '''The deadline for KDE to apply as an organization is March 26, 2021 at 18:00 UTC'''
-* Registration for mentors and admins opens on April 2, 2019 at 20:00 UTC.
+* Google will announce which organizations have been accepted into the program on April 16, 2021 at 18:00 UTC.
-* Google will announce which organizations have been accepted into the program on April 30, 2019 at 12:00 UTC.
+* Technical writer hiring deadline on May 17, 2021
-* Technical writers can start submitting applications on May 29, 2019 at 18:00 UTC. '''The deadline for technical writers to apply is June 28, 2019 at 18:00 UTC.'''
-* Google will announce the list of accepted technical writers and their projects on July 30, 2019 at 18:00 UTC.
 '''Full Season of Docs timeline''': https://developers.google.com/season-of-docs/docs/timeline
------
+== How to contact us ==
-'''Rules and requirements'''
-* KDE must have at least two organization administrators to manage our participation in Season of Docs.
-* We must have at least two mentors for each technical writing project we plan to accept. Mentors do not need to be technical writers by profession.
-* KDE can submit two project ideas in our application for Season of Docs. We will select the ideas from [https://community.kde.org/GSoD#Project_Ideas the list of proposals below].
-* Our administrators and mentors should register in the Season of Docs system. Registration opens on April 2, 2019 at 20:00 UTC.
-* The deadline for KDE to apply as an organization is April 23, 2019.
-* Individuals are not allowed to participate in Season of Docs as both mentors and technical writers. In other words, you can't be a mentor for a KDE project and apply as a technical writer to contribute to some other project.
-* Individuals with previous experience in contributing to KDE can apply as technical writers as part of Season of Docs, but they must indicate their previous relationship with KDE in their application.
-* Individuals applying to participate as technical writers must be at least 18 years old at time of registration; able to demonstrate prior technical writing experience by submitting role descriptions and work samples; eligible to work in their country of residence during duration of program; and residents of a country not currently embargoed by the United States.
-*KDE is not obligated to use the materials produced by technical writers as part of Season of Docs, regardless of whether the projects are successfully completed or not.
-'''Complete Season of Docs rules'''
-https://developers.google.com/season-of-docs/terms/program-rules
-__TOC__
-== Guidelines  ==
-=== Information for Mentors ===
-=== Information for Technical Writers ===
-== Project Ideas ==
-As an organization applying to participate in Season of Docs, KDE can submit two project proposals. Everyone is invited to suggest a project idea!
-'''The deadline for KDE to apply as an organization is April 23, 2019 at 20:00 UTC.'''
-If you have any ideas, please add them to this page as soon as possible. Early proposals will get more attention and feedback because people will have more time to read them.
-Keep your proposals simple, with clear descriptions.
-Do not add proposals that cannot be accomplished over the duration of the program (three months) or that are not related to KDE.
-Feel free to add more than one proposal. You can also indicate your priorities; for example, which one of your proposals you find more important and impactful.
-Be prepared to add yourself as a mentor for the project(s) you are proposing, or at least to help find two suitable mentors among KDE community members.
-=== Project Proposal Template ===
-'''Project:''' The main idea of your proposed project
-'''Basic work breakdown:''' What types of tasks will the project include; how they could be distributed throughout the program
-'''Expected results:''' What needs to be produced to consider the project completed ("definition of done")
-'''Benefit for KDE:''' How will the community benefit from this project; both short- and long-term
-'''Benefit for the technical writer:''' What will the technical writer gain from this project (new skills, specific knowledge...)
-'''Prerequisites:''' If any specialized tools or technologies are required to complete the project, they should be listed here. If some skills are good-to-have, but not required, they can also be mentioned in this section
-'''Mentor:''' If the person submitting the proposal is willing to also mentor the project, they should put their name here. If submitting a proposal without a defined mentor, leave this field empty. However, proposals without a defined mentor will be given lower priority. You should discuss such proposals in [https://webchat.kde.org/#/room/%23kde-sod:kde.org the official kde-sod channel] before adding them to this page.
-=== Overhaul Kirigami documentation ===
-**Problem:** Kirigami is a relatively new framework to create convergent applications with only little documentation. This makes it difficult for newcomers to use Kirigami. The goal will be to build on previous efforts to improve the documentation and properly document the components with explanations how to use them, code examples, and screenshots. Previous efforts can be found [[https://develop.kde.org/docs/kirigami/ here]].
-'''How would we measure success?'''
-* Users of Kirigami won't need to look at the source code of Kirigami or Kirigami-based applications to build their own Kirigami application.
-* Increase the adoption of Kirigami inside KDE and also outside.
-'''What skills would a technical writer need to work on this project?'''
-* **Must have:** Familiarity with Gitlab/Github merge request workflow (or willingness to work through Gitlab tutorials)
-* **Nice to have:** Previous QML knowledge but if you don't we will help you get started. Doxygen and/or markdown knowledge are also a plus but it easy to learn the syntax.
-**Volunteers**
-* Carl Schwan: Happy to help with questions about the documentation tooling and Kirigami.
-**Contact info:**
-Technical writers interested in working on this project should contact us on Matrix [https://webchat.kde.org/#/room/#developer-doc:kde.org #developer-doc:kde.org] or alternatively send a mail to carl at carlschwan dot eu. Please include links to your technical writing work or portfolio/résumé/CV.
+We have three 4 ideas that can be found on the [https://community.kde.org/GSoD/2021 proposal page] and are offered by two teams.
-=== Project Idea 2 ===
+If you are interested in contributing to the Kirigami proposal, you can go to the Matrix [https://webchat.kde.org/#/room/#kirigami:matrix.org #kirigami:kde.org] or directly contact the mentor on Matrix [https://webchat.kde.org/#/room/@carl:kde.org @carl:kde.org] or by mail carl at carlschwan.eu.
-=== Project Idea 3 ===
+If you are interested in contributing to the Uyuni Project project you can contact find all the contact information on that [https://www.uyuni-project.org/pages/contact.html#irc page]