Re: [gentoo-soc] Weekly report 07/30

[Andrew Savchenko <bircoph@gentoo.org>]

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

Hi!

On Sun, 29 Jul 2018 08:36:14 -0700 Brian Dolbec wrote:
> > While I am not directly involved with gsoc this year... I can't help
> > but to respond here.
> > 
> > Reports like this were not acceptable in past years.
> > 
> > Just showing a link to a report is not enough.
> > 
> > A PROPER report here should include enough info to give the reader an
> > idea if they want to follow the link and get all the details.
> > 
> > While I don't expect a 3 page essay, you should summarize what was
> > done in brief, but clear writing.  The link to the full detailed
> > report at the end.
> 
> I should have followed the link before responding...
> 
> The link contents is no more than a brief summary.  I didn't do a word
> count, but, I think my previous reply was about the same size...  So
> how hard would it have been to copy/paste that text into an email...
> 
> But I still find that report lacking for a detailed report.  You should
> have included some details of what was done for the automatic setup.
> 
> Also, why are your user guides just in a blog? Shouldn't the user guides
> be added to the Gentoo wiki?  Blog guide info I would think would only
> be for brief preliminary help info for mentors and other actively
> interested persons.  So as the project progressed, they could keep up
> to date with the code.  But the real documentation should in my
> opinion be put somewhere central like our Gentoo wiki.

Brian, looks like you missed our workflow. Weekly e-mail reports
are just pointers to the work done this week and documented in the
blog.

The blog entry itself is exactly what you described as "you should
summarize what was done in brief, but clear writing.  The link to
the full detailed report at the end." It contains clear summary
with each paragraph linked to the detailed technical or
workflow description. Just follow the links on the blog page:
  https://jsteward.moe/category/gsoc-2018.html
(the first link is broken now by some typo and will be fixed).

As for documenting in the wiki, please see previous week's report:
  https://jsteward.moe/weekly-report-0723.html
So moving essential parts of the blog posts to the wiki is on the
plan.

But frankly having the job done and documentation written is more
important than bikeshedding about where the docs must be located.
IMHO Wiki is not the best place for them, for one of the reasons ask
williamh why.

Best regards,
Andrew Savchenko

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