Google Season of Docs 2020: Difference between revisions
(Starting GSoD2020 page) |
(Start 'Project Ideas' entry) |
||
| Line 2: | Line 2: | ||
QEMU is applying to [https://developers.google.com/season-of-docs Google Season of Docs 2020]. This page contains our ideas list and information for technical writers and mentors. | QEMU is applying to [https://developers.google.com/season-of-docs Google Season of Docs 2020]. This page contains our ideas list and information for technical writers and mentors. | ||
= Project Ideas = | |||
This is the listing of suggested project ideas. Technical writers are free to suggest their own projects, see [[#How to propose a custom project idea]] below. | |||
== User Documentation == | |||
{{:Internships/ProjectIdeas/UserStories}} | |||
== Developer Documentation == | |||
{{:Internships/ProjectIdeas/ComponentsBigPicture}} | |||
{{:Internships/ProjectIdeas/ComponentsRelationship}} | |||
{{:Internships/ProjectIdeas/HowToWriteNewDevice}} | |||
{{:Internships/ProjectIdeas/HowToWriteNewMachine}} | |||
== How to add a project idea == | |||
# Create a new wiki page under "Internships/ProjectIdeas/YourIdea" and follow [[#Project idea template]]. | |||
# Add a link from this page like this: <nowiki>{{:Internships/ProjectIdeas/YourIdea}}</nowiki> | |||
== Project idea template == | |||
<nowiki>=== TITLE === | |||
'''Summary:''' Short description of the project | |||
Detailed description of the project. | |||
'''Links:''' | |||
* Wiki links to relevant material | |||
* External links to mailing lists or web sites | |||
'''Details:''' | |||
* Skill level: beginner or intermediate or advanced | |||
* Mentor: Email address and IRC nick | |||
* Suggested by: Person who suggested the idea</nowiki> | |||
Latest revision as of 07:48, 22 April 2020
Introduction
QEMU is applying to Google Season of Docs 2020. This page contains our ideas list and information for technical writers and mentors.
Project Ideas
This is the listing of suggested project ideas. Technical writers are free to suggest their own projects, see #How to propose a custom project idea below.
User Documentation
Internships/ProjectIdeas/UserStories
Developer Documentation
Internships/ProjectIdeas/ComponentsBigPicture Internships/ProjectIdeas/ComponentsRelationship Internships/ProjectIdeas/HowToWriteNewDevice Internships/ProjectIdeas/HowToWriteNewMachine
How to add a project idea
- Create a new wiki page under "Internships/ProjectIdeas/YourIdea" and follow #Project idea template.
- Add a link from this page like this: {{:Internships/ProjectIdeas/YourIdea}}
Project idea template
=== TITLE === '''Summary:''' Short description of the project Detailed description of the project. '''Links:''' * Wiki links to relevant material * External links to mailing lists or web sites '''Details:''' * Skill level: beginner or intermediate or advanced * Mentor: Email address and IRC nick * Suggested by: Person who suggested the idea