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.
Thank you, Niteesh. On Mon, Mar 23, 2020 at 8:29 PM Gedare Bloom <ged...@rtems.org> wrote: > On Mon, Mar 23, 2020 at 3:35 AM Niteesh G. S. <niteesh...@gmail.com> > wrote: > > > > On Mon, Mar 23, 2020 at 11:58 AM Sebastian Huber < > sebastian.hu...@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 >
_______________________________________________ devel mailing list devel@rtems.org http://lists.rtems.org/mailman/listinfo/devel
