Re: [PATCH 00/32] Create an User's manual and improve development-process book

[Mauro Carvalho Chehab]

Em Mon, 17 Oct 2016 16:43:42 -0600
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> I've only been able to take a quick look at these - I'm buried fairly deep
> at the moment.  A few superficial thoughts.
> 
> On Mon, 17 Oct 2016 14:55:37 -0200
> Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx> wrote:
> 
> > In my opinion, it would be better to move the converted files to be inside
> > a Sphinx build directory, but Jon seems reluctant to that, so, this series
> > use symlinks, as it is easy to move the files in the future with a very simple
> > patch, if we decide to do so.  
> 
> So I raised this topic in talks at both Kernel Recipes and LinuxCon
> Europe, and nobody threw things at me.  I have come to suspect that I'm
> worrying a little too much about it; maybe we should go ahead and move
> the documents and see who screams.  The work could go into docs-next soon,
> and there would be an opportunity to fix things up if all hell breaks
> loose at the kernel summit.
> 
> Can I make some silly requests?
> 
> - Can we move development-process to something shorter, like just
>   "process"?  We'll be typing it a lot, and tab completion doesn't work in
>   most email clients :)

OK!

> - I think we should leave pointers behind in the form of one-line "this
>   file has moved" messages.  Probably only SubmittingPatches and
>   CodingStyle need that treatment, I think.

Ok. Following such logic, I guess we should also add a similar notice to
the main README file too, that will be at the "user/admin-guide".

I would actually be a little more verbose there, providing pointers to the
main documentation books (e. g. the non-subsystem specific ones) there, 
like:

	The content of this file was moved to
	  Documentation/admin-guide/README.rst
	For Kernel's build and admin documentation, please see 
	  Documentation/admin-guide;
	For guides about the Kernel development process, please see
	  Documentation/process;
	...

> - The "user manual" is certainly something that has been on my mind as
>   well.  We have documentation for completely separate audiences all mixed
>   together now, and definitely need to fix that.  But rather than "user",
>   can we paint that shed "admin-guide" or something like that?  

Ok! "admin-guide" sounds a good name.

> Thanks for doing all of this,

Anytime!

Thanks,
Mauro