[Kss-devel] move doc directory from egg trunk to package root?

[Godefroid Chapelle]

Jeroen Vloothuis wrote:
> Godefroid Chapelle wrote:
>> Balazs Ree wrote:
>>  
>>> The doc directory was placed intentionally to the egg root. The 
>>> reason for this was that all the other packages in Plone followed 
>>> this standard, and also that ZopeSkel generates this standard package 
>>> structure. Also initially when the docs were not yet here, I was 
>>> asked by Wichert to comply to this convention, and so I did.
>>>
>>> I personally do not see any reason for moving the doc down to the 
>>> package import root, and have not previously heard any discussion 
>>> about this. So please, in case you are in favour of this change, go 
>>> ahead and present your pros!
>>>     
>> The main reason for moving the docs directory is that headers of our 
>> files mention a CREDITS.txt and a LICENSE.txt.
>>   
> I would like to ask a few things about this:
> 
> 1. do we need these headers at all?

I think it makes sense to 1) recognize credit of the authors and 2) to 
remind people which license comes with the code they receive/use.

> 2. can't we have a pointer license.txt or something which points to the 
> original archive with everything in it instead of moving everything over?

What do you mean by the original archive ?

> 3. most packages in the wild seem to have docs at the setup.py level 
> (perhaps you have some good examples to the contrary?). Why is KSS 
> different?

This argument feels weak. Should we move to PHP and JQuery because most 
CMS in the wild are PHP and JQuery ?

-- 
Godefroid Chapelle (aka __gotcha) http://bubblenet.be