[gentoo-project] Are we participating in Season of Docs?

[gentoo-project] Are we participating in Season of Docs?

[Michał Górny]

[-- Attachment #1: Type: text/plain, Size: 446 bytes --]

Hi,

I've been made aware that Google is launching a new program called
Season of Docs [1].  This seems like an opportunity to improve decaying
Gentoo documentation.

I haven't been able to find any mention of it throughout gentoo.org. 
Are we interested in participating?  Do we have an org admin already,
or anyone willing to do the needful?

[1]:https://developers.google.com/season-of-docs/

-- 
Best regards,
Michał Górny


[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 963 bytes --]

Re: [gentoo-project] Are we participating in Season of Docs?

[Andrew Savchenko]

[-- Attachment #1: Type: text/plain, Size: 2576 bytes --]

Hi!

On Tue, 19 Mar 2019 07:05:02 +0100 Michał Górny wrote:
> Hi,
> 
> I've been made aware that Google is launching a new program called
> Season of Docs [1].  This seems like an opportunity to improve decaying
> Gentoo documentation.

Thanks for bringing this subject up.

> I haven't been able to find any mention of it throughout gentoo.org. 
> Are we interested in participating? Do we have an org admin already,
> or anyone willing to do the needful?

I'm not aware of any activity yet.

It should not be hard to setup organization details, because GSoC
application [1] may be reused. For financial details (likely for a
Payoneer account) current GSoC admins (alicef and lu_zero) may be
contacted, or trustees of course.

In my opinion more important problem is what exact project ideas do
we have? We'll need to have a list of those before the organization
application deadline as well as some people ready to be mentors.

For the ideas we definitely can work on improving wiki. But on what
exact topic? May the wiki team help here?

Another direction is development documentation like devmanual, but
I do not have exact topics there as well.

However I can point to one possible task: improve man 5 ebuild. It
is vastly outdated and does not reflect EAPI 7 properly. Though
this task alone is not sufficient for 3 month worth of work, likely
for 3-4 weeks or so.

Anyway I may help with mentoring or administration, if it is
required: Season of Docs don't have a major time intersection [2]
with GSoC, so it should be manageable for me.

We still have a lot of time [2] to submit the organization
application, but we should have some project topics ready.

The interesting point of the Season of Docs is that participants
scope is not limited to students [3, paragraph 7], however prior
experience in technical writing is mandatory [4].

In order to write good documentation a technical writer must be
well acquainted with a project being documented. Of course some of
this knowledge may be obtained during the early phases of the
program, but not all. So it is likely we'll have to pick someone
already using Gentoo, but not Gentoo developer. This puts further
limit on the scope.

[1] https://wiki.gentoo.org/wiki/Google_Summer_of_Code/2018/Organization_application
[2] https://developers.google.com/season-of-docs/docs/timeline
[3] https://developers.google.com/season-of-docs/terms/program-rules
[4] https://developers.google.com/season-of-docs/docs/tech-writer-guide

Best regards,
Andrew Savchenko

[-- Attachment #2: Type: application/pgp-signature, Size: 833 bytes --]

Re: [gentoo-project] Are we participating in Season of Docs?

[Michał Górny]

[-- Attachment #1: Type: text/plain, Size: 1207 bytes --]

On Mon, 2019-03-25 at 00:26 +0300, Andrew Savchenko wrote:
> Hi!
> 
> On Tue, 19 Mar 2019 07:05:02 +0100 Michał Górny wrote:
> > Hi,
> > 
> > I've been made aware that Google is launching a new program called
> > Season of Docs [1].  This seems like an opportunity to improve decaying
> > Gentoo documentation.
> 
> Thanks for bringing this subject up.
> 
> > I haven't been able to find any mention of it throughout gentoo.org. 
> > Are we interested in participating? Do we have an org admin already,
> > or anyone willing to do the needful?
> 
> I'm not aware of any activity yet.
> 
> It should not be hard to setup organization details, because GSoC
> application [1] may be reused. For financial details (likely for a
> Payoneer account) current GSoC admins (alicef and lu_zero) may be
> contacted, or trustees of course.
> 
> In my opinion more important problem is what exact project ideas do
> we have? We'll need to have a list of those before the organization
> application deadline as well as some people ready to be mentors.

I suppose we should make a wiki page like for GSoC, and let people write
down their ideas there.

-- 
Best regards,
Michał Górny


[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 963 bytes --]