Re: [KERNEL NEWBIES ACCESS] Sumitra Sharma

["Fabio M. De Francesco" <fmdefrancesco@gmail.com>]

On venerdì 17 marzo 2023 12:05:09 CET Fabio M. De Francesco wrote:
> On giovedì 16 marzo 2023 09:31:16 CET Sumitra Sharma wrote:
> > On Sun, Mar 12, 2023 at 10:07:57AM -0700, Sumitra Sharma wrote:
> > > 2. The outreachy document directly links the ".rst" file
> > > https://elixir.bootlin.com/linux/latest/source/Documentation/process/
> 
> coding-
> 
> > > style.rst at many places under different sections. And as noted by fabio
> > > there is a difference between the .rst source files content and its
> > > corresponding .html file which can lead to confusions and missing
> 
> important
> 
> > > information. I would like to suggest to change the links to the 
.html/.pdf
> > > files rather than the > .rst source files.
> > 
> > Hi mentors
> > 
> > I would like to have some update on this.
> > 
> > Regards,
> > 
> > Sumitra
> 
> Hi Sumitra,
> 
> As you know I'm for this change.
> AFAIK, only Alison can grant you the permission to access that document in
> write mode.
> If she hasn't granted that access to you yet, please ask her directly with 
an
> email to her address.
> 
> Thanks for working on this (important, from my POV) change.
> 
> Fabio

Sumitra,

When doing this change, please skim the whole document and replace _all_ the 
links to the .rst files (regardless they point to elixir.bootlin.com or not) 
with the corresponding generated .html in kernel.org.

The document about the Highmem subsystem which I showed you is useless in .rst 
format from the point of view of people who needs to learn its content. I'm 
not sure whether or not we have the same problem with the Linux kernel 
development guidelines, however it does not matter how much it differs from 
the human readable counterpart.

We should make it clear that the source .rst is never the right document to 
consult, unless one want to make changes. The generated documentation from 
.rst with "make htmldocs" (or with other similar commands for .pdf and .epub) 
should be the only to consult for purposes of study (it does not matter if one 
generates them locally or find them in the "documentation" section of the 
kernel.org website).

Thanks,

Fabio

P.S.: I just saw the last message from Julia (in this same thread) regarding 
Mutt configuration. I want to echo her and ask you or other Applicants for 
making also those changes. Don't forget that Alison said that they count as 
contributions that you can add in your records.