[PATCH] user/gsoc: GSoC Getting Started Instructions

[Gedare Bloom]

On Mon, Mar 23, 2020 at 3:35 AM Niteesh G. S. <niteesh.gs at gmail.com> wrote:
>
> On Mon, Mar 23, 2020 at 11:58 AM Sebastian Huber <sebastian.huber at embedded-brains.de> wrote:
>>
>> On 23/03/2020 06:59, Niteesh G. S. wrote:
>>>
>>>  From here on I would prefer references to the existing documentation
>>> with any GSoC details list here. I would prefer we avoid duplicating
>>> prefix, sources and building anywhere in the documentaion as it will
>>> only confuse search engines, normal users and GSoC students. The Quick
>>> Start Guide has taken a long time to get to where it is. If there is
>>> something in the Quick Start guide that needs fixing please let me know.
>>
>> I had this discussion with Gedare. We felt it would be nice to have all the
>> instructions in once place instead of referencing them. It would make it
>> easier for newcomers and students to follow.
>> Maybe I'll use the same prefix as in the Quick Start guide but have all the
>> instructions here.
>>
>> In case the Quick Start section is difficult to follow for newcomers and students, then the Quick Start should be fixed. I am also not in favour of duplicating content and prefer references. All this duplication makes it very hard to maintain the documentation. I am sorry if that this causes some extra work for you.
>
> By difficult to follow I mean that it is just too much information for a student who just wants
> to set up an initial functioning development environment. But, also having all that information
> is important to get an understanding of the process that happens in the background.

The original intent of GSoC Getting Started Tutorial was to provide
simplified instructions to get into some baseline development
environment. Over time with the evolution of RSB and recent revamping
of the Quick Start, I think perhaps we do have the opportunity to
merge these instructions somewhat.  However, there are extra details
in Quick Start that are not necessary for getting into a development
environment asap. Perhaps provide a "GSoC Getting Started" as a
subchapter in the Quick Start that points to all the relevant sections
with explicit instructions (use erc32, use master branch, etc.) and
then the "proof" request along with contacting the ML after reviewing
open project. The last part is still only relevant to GSoC students
(or students in general that just want to get started).

Gedare