[PATCH] user/gsoc: GSoC Getting Started Instructions

[Gedare Bloom]

On Sun, Mar 29, 2020 at 11:47 PM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> On 28/03/2020 19:47, Niteesh G. S. wrote:
>
> We have an Installation chapter under the User manual https://docs.rtems.org/branches/master/user/installation/index.html
> But it isn't detailed enough like the quick start guide. IMO it is the right place to add detailed instructions. It already has important
> information for a good setup like sandboxing, differences between a release and dev. version, host toolchain setup and more.
> Should we move all the details from quick-start chapter to the installation chapter and make the quick start guide simple enough for a
> student to begin with.
> We could add a subsection about GSoC under quick-start and ask the students to refer to the quick-start chapter.
>
> We should really try to consolidate the documentation. Having mostly the same stuff in different places is a maintenance problem. The intention of the Quick Start chapter is to get started quickly step by step on a simulator platform which is able to run the RTEMS test suite properly. You should be able to use it as a template for your desired target system. Getting started on a simulator platform should be the right thing for a GSoC student?

The concern is that the Quick Start includes a lot of extra material
that makes it not so "Quick" to use. There are also many decisions
that need to be made when following the quick start that makes it not
exactly a linear set of directions.

That said, I agree that consolidation is important. Niteesh, would you
be willing to draft a subsection in the Quick Start (maybe near the
beginning) that provides a set of instructions to walk-through the
remainder of the quick start oriented toward GSoC students, pointing
out the decision to make at each "decision point" -- such as, In
Section 2.3 use the "Git" instructions; in Section 2.6 use the "Manual
BSP Build", etc. These should be written as linked references to those
sections/subsection names.

Gedare