From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <gentoo-soc+bounces-2375-garchives=archives.gentoo.org@lists.gentoo.org>
Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
(No client certificate requested)
by finch.gentoo.org (Postfix) with ESMTPS id 308EB138334
for <garchives@archives.gentoo.org>; Mon, 30 Jul 2018 02:18:12 +0000 (UTC)
Received: from pigeon.gentoo.org (localhost [127.0.0.1])
by pigeon.gentoo.org (Postfix) with SMTP id F1094E0963;
Mon, 30 Jul 2018 02:18:10 +0000 (UTC)
Received: from mail-oi0-x231.google.com (mail-oi0-x231.google.com [IPv6:2607:f8b0:4003:c06::231])
(using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits))
(No client certificate requested)
by pigeon.gentoo.org (Postfix) with ESMTPS id A0AFDE0963
for <gentoo-soc@lists.gentoo.org>; Mon, 30 Jul 2018 02:18:10 +0000 (UTC)
Received: by mail-oi0-x231.google.com with SMTP id 13-v6so18495454ois.1
for <gentoo-soc@lists.gentoo.org>; Sun, 29 Jul 2018 19:18:10 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=jsteward.moe; s=google;
h=mime-version:in-reply-to:references:from:date:message-id:subject:to;
bh=iECKBufDNPtAAqu5bAAEdnZR2SqyzmkeINxuoZjCy8k=;
b=eqDg0eL0LLF7BhYBMsBr8PaZE0QJkXvfTaylQSZtjHgBLpeWEK5h4VXmwnaqSlDFjR
nckUewFtlcQw6YuxxHJkszsuPCJ6ZDdKpFWc++S2iz1HoHV7sqBq6tw0IdYbQUhDA0TY
h7tqi4F74GOg2RjmEhdUBpu33MB0WELReiGWGjzeFxnwlA2+cfOegWv2Hv/cp0tycm3L
QrF01VfjICAZ7etC7svu5tvhUmeWgiGgO+dRONUJiKIKEjtZeDW/FEQu9DTRWaC9LbiH
TYFQwV7fm+xtqOJacG8LK0tZY3VjUBHLMN27krsIfOMG+HsIO2jN86GqR7qN8sA8bEPu
Sr4A==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20161025;
h=x-gm-message-state:mime-version:in-reply-to:references:from:date
:message-id:subject:to;
bh=iECKBufDNPtAAqu5bAAEdnZR2SqyzmkeINxuoZjCy8k=;
b=ORa2cO18rcCspAFXtHfmo3TdeiPaZieXpL506SG5TUunJtxZUUrPscw6WUKnjji2ys
tBuluMu2pO63h6Uxg4ivT8lfN1/WLbgWuTmM4ZAW0zpyN6wCw5pTrHbeFHjq6Fn8HcGL
jDdUaX5jsFVYJtG6T1XR9zMtlzfMVDb1uUEkomhxnihI6DJZ9kpPKJAnBAKfH+UZgsEF
WvBJbtPtbvq+6HTedM29ZU0GbFvpc68A/w8J8kiuxrZwY/7otGtiPSUFvq1ZtWUyUgBF
sCI2vXJmGxPBPKJ7RtVCXhIirzqHH7cqg5ATgAQsxvKzQy+WChx9zlhKEDpeKx5nKJqr
Chvg==
X-Gm-Message-State: AOUpUlGqiM35JLx9UxZwg9aPS55GEuAKqN5DiIuxsI1rMXssDf1qPjJ5
5lxYx4zmD+iA99JjmAqTpMtdku+VEm+Sa4EJQaEpHkrtNYgRMA==
X-Google-Smtp-Source: AAOMgpfnYYMb6IgQQIEqo+mdcGeHyPnvlQj28Z4xlKyW7Mksev7dqujnuFFQt3ub3KS4y2ma89xsDpEQDIJxxK3RQTQ=
X-Received: by 2002:aca:ea05:: with SMTP id i5-v6mr16841174oih.60.1532917089331;
Sun, 29 Jul 2018 19:18:09 -0700 (PDT)
Precedence: bulk
List-Post: <mailto:gentoo-soc@lists.gentoo.org>
List-Help: <mailto:gentoo-soc+help@lists.gentoo.org>
List-Unsubscribe: <mailto:gentoo-soc+unsubscribe@lists.gentoo.org>
List-Subscribe: <mailto:gentoo-soc+subscribe@lists.gentoo.org>
List-Id: Gentoo Linux mail <gentoo-soc.gentoo.org>
X-BeenThere: gentoo-soc@lists.gentoo.org
Reply-to: gentoo-soc@lists.gentoo.org
MIME-Version: 1.0
Received: by 2002:ac9:1481:0:0:0:0:0 with HTTP; Sun, 29 Jul 2018 19:18:09
-0700 (PDT)
In-Reply-To: <20180729083614.242a40c9@professor-x>
References: <CADuippCJ+dsd4HdUUx4Kx=8fO4nqOCcrSAZ37gRQRy1-ma0n=A@mail.gmail.com>
<20180729082001.3a3f3c4e@professor-x> <20180729083614.242a40c9@professor-x>
From: Pengcheng Xu <i@jsteward.moe>
Date: Mon, 30 Jul 2018 10:18:09 +0800
Message-ID: <CADuippA5tMjfc_vx6BYAr83HkR3+ak5iH4L6MjJYGOAThpeTMA@mail.gmail.com>
Subject: Re: [gentoo-soc] Weekly report 07/30
To: gentoo-soc@lists.gentoo.org
Content-Type: text/plain; charset="UTF-8"
X-Archives-Salt: ab61dec2-5930-4f5d-8206-4b1d1e4ceb7e
X-Archives-Hash: d774fdb765aaa6bccc1d7ed7a2a4a86a
Hi Brian,
2018-07-29 23:36 GMT+08:00 Brian Dolbec <dolsen@gentoo.org>:
> On Sun, 29 Jul 2018 08:20:01 -0700
> Brian Dolbec <dolsen@gentoo.org> wrote:
>
>> On Sun, 29 Jul 2018 21:40:30 +0800
>> Pengcheng Xu <i@jsteward.moe> wrote:
>>
>> > Hi all,
>> >
>> > Last week's report is available now. Link:
>> >
>> > https://jsteward.moe/weekly-report-0730.html
>> >
>> > Thanks!
>> >
>>
>> 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...
My GSoC weekly report workflow had been like that throughout the project: full
reports, be it long or short, stays on my blog. When the report is
short, the email
usually contains just a link, and the report holds links as well as
descriptions of
each separated topic. Sometimes the descriptions are omitted as the
titles clearly
express what the articles are about.
>
> 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.
Sorry for the overly-concise README for the sharkbait-setup
repository. I updated
the README and added a link to the blog article when the work is first
produced (detailed
steps without any kind of script automation).
>
> 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.
There are two reasons that I first write my articles on my blog:
1. I am not familiar with the markup language used in MediaWiki; I
usually write in MarkDown
instead. Switching over to a new Markup language disrupts the
process of writing and is
time-consuming. I plan to use pandoc to convert MarkDown to
MediaWiki and post on Gentoo
Wiki instead of directly writing the guides on the Wiki.
2. IMHO a consistent place where all information can be found is
important. My blog about
the project contains too many details that people won't care, so
not everything is suitable to
be on the Wiki. That's why I've chosen to scrub the articles and
pick important ones and post
them on the Wiki, not directly writing everything on the Wiki.
Thanks!
--
Pengcheng Xu
i@jsteward.moe