| 1 | |
| 2 | = Season of Docs = |
| 3 | |
| 4 | [[TOC(GSoD, depth=2)]] |
| 5 | |
| 6 | RTEMS has applied to be a participating organization in [https://developers.google.com/season-of-docs Google Season of Docs 2019]. |
| 7 | |
| 8 | Please use this page as a jumping off point for participating in GSoD with RTEMS, and ask plenty of questions. We want you to be a part of the RTEMS community! |
| 9 | |
| 10 | '''Potential Technical Writers''': |
| 11 | |
| 12 | * Read through all the material on this page. |
| 13 | |
| 14 | * Talk to us on IRC (#rtems on freenode.net) or the RTEMS mailing lists. |
| 15 | |
| 16 | * If accepted as an organization, students applying to the RTEMS Project will need to fill out an application at [https://developers.google.com/season-of-docs Google Season of Docs]. |
| 17 | |
| 18 | * You will also need to fill in and later update the information found on the [wiki:GSoD/2019 RTEMS GSoD 2019] tracking page. |
| 19 | |
| 20 | * We also require you to build the current RTEMS documentation, modify it, and build it again. The [wiki:GSoD/GettingStarted GSoD Getting Started] page has some more information. |
| 21 | |
| 22 | * Pick a project from the list at [wiki:Developer/DocsProjects Documentation Projects]. This is by no means an all-inclusive list and we are open to suggestions. Submissions of new high-quality documentation that fills a need are always welcomed. |
| 23 | |
| 24 | * Write to your heart's content and have a great experience! |
| 25 | |
| 26 | |
| 27 | '''Potential Mentors''': |
| 28 | |
| 29 | * Share your knowledge and pledge to help a tech writer. |
| 30 | |
| 31 | * Visit the [https://developers.google.com/season-of-docs Google Season of Docs] to register and open a connection with RTEMS Project. |
| 32 | |
| 33 | * Update your information at the [wiki:GSoC/Mentors RTEMS Mentors] page. |
| 34 | |
| 35 | * Help the tech writer succeed! |
| 36 | |
| 37 | |
| 38 | = General Program Information and Guidance = |
| 39 | |
| 40 | * [https://developers.google.com/season-of-docs Google's Starting Page for the Season of Docs] |
| 41 | * [https://developers.google.com/season-of-docs/docs/ GSoD Guides] - Advice for mentors and tech writers. |
| 42 | |
| 43 | The RTEMS project will furnish not only a mentor, but a co-mentor, and one or two additional people to help with keeping effort meaningful for everyone involved. |
| 44 | |
| 45 | We really want your experience to be the first step in your successful and long term participation in our project or with other open-source documentation efforts. |
| 46 | |
| 47 | ---- |
| 48 | |
| 49 | = Tech Writer Information = |
| 50 | |
| 51 | We want you to hit the ground running, so you need to build RTEMS documentation, modify it a little, and regenerate the documentation. Please visit the RTEMS [wiki:GSoD/GettingStarted GSoD Getting Started] page for details. |
| 52 | |
| 53 | Please read through the [wiki:Developer/GSoD/ProjectManagement GSoD Project Management] page to get a sense of our expectations from you for the Season of Docs. |
| 54 | |
| 55 | Fill out the [https://developers.google.com/season-of-docs official Google application] and fill out an entry in the [wiki:GSoD/2019 RTEMS GSoD 2019 tracking page]. |
| 56 | |
| 57 | ---- |
| 58 | |
| 59 | = References = |
| 60 | |
| 61 | * [https://developers.google.com/season-of-docs/docs/ GSoD Documentation] |
| 62 | |
| 63 | ---- |
| 64 | |
| 65 | = Historical Information = |
| 66 | |
| 67 | The RTEMS Community is proud to have participated in previous editions of the [https://developers.google.com/open-source/soc/ Google Summer of Code] as well as [https://developers.google.com/open-source/gci/ Google Code-in (GCI)], and in multiple editions of the European Space Agency [http://sophia.estec.esa.int/socis/?q=node/13 Summer of Code in Space]. We are excited to be applying to participate in the inaugural [https://developers.google.com/season-of-docs Google Season of Docs]. |