| 1 |
Hi! |
| 2 |
|
| 3 |
On Tue, 19 Mar 2019 07:05:02 +0100 Michał Górny wrote: |
| 4 |
> Hi, |
| 5 |
> |
| 6 |
> I've been made aware that Google is launching a new program called |
| 7 |
> Season of Docs [1]. This seems like an opportunity to improve decaying |
| 8 |
> Gentoo documentation. |
| 9 |
|
| 10 |
Thanks for bringing this subject up. |
| 11 |
|
| 12 |
> I haven't been able to find any mention of it throughout gentoo.org. |
| 13 |
> Are we interested in participating? Do we have an org admin already, |
| 14 |
> or anyone willing to do the needful? |
| 15 |
|
| 16 |
I'm not aware of any activity yet. |
| 17 |
|
| 18 |
It should not be hard to setup organization details, because GSoC |
| 19 |
application [1] may be reused. For financial details (likely for a |
| 20 |
Payoneer account) current GSoC admins (alicef and lu_zero) may be |
| 21 |
contacted, or trustees of course. |
| 22 |
|
| 23 |
In my opinion more important problem is what exact project ideas do |
| 24 |
we have? We'll need to have a list of those before the organization |
| 25 |
application deadline as well as some people ready to be mentors. |
| 26 |
|
| 27 |
For the ideas we definitely can work on improving wiki. But on what |
| 28 |
exact topic? May the wiki team help here? |
| 29 |
|
| 30 |
Another direction is development documentation like devmanual, but |
| 31 |
I do not have exact topics there as well. |
| 32 |
|
| 33 |
However I can point to one possible task: improve man 5 ebuild. It |
| 34 |
is vastly outdated and does not reflect EAPI 7 properly. Though |
| 35 |
this task alone is not sufficient for 3 month worth of work, likely |
| 36 |
for 3-4 weeks or so. |
| 37 |
|
| 38 |
Anyway I may help with mentoring or administration, if it is |
| 39 |
required: Season of Docs don't have a major time intersection [2] |
| 40 |
with GSoC, so it should be manageable for me. |
| 41 |
|
| 42 |
We still have a lot of time [2] to submit the organization |
| 43 |
application, but we should have some project topics ready. |
| 44 |
|
| 45 |
The interesting point of the Season of Docs is that participants |
| 46 |
scope is not limited to students [3, paragraph 7], however prior |
| 47 |
experience in technical writing is mandatory [4]. |
| 48 |
|
| 49 |
In order to write good documentation a technical writer must be |
| 50 |
well acquainted with a project being documented. Of course some of |
| 51 |
this knowledge may be obtained during the early phases of the |
| 52 |
program, but not all. So it is likely we'll have to pick someone |
| 53 |
already using Gentoo, but not Gentoo developer. This puts further |
| 54 |
limit on the scope. |
| 55 |
|
| 56 |
[1] https://wiki.gentoo.org/wiki/Google_Summer_of_Code/2018/Organization_application |
| 57 |
[2] https://developers.google.com/season-of-docs/docs/timeline |
| 58 |
[3] https://developers.google.com/season-of-docs/terms/program-rules |
| 59 |
[4] https://developers.google.com/season-of-docs/docs/tech-writer-guide |
| 60 |
|
| 61 |
Best regards, |
| 62 |
Andrew Savchenko |
Archives