Re: collective.developermanual is now on plone.org

Israel Saeta Pérez <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
Martin Aspeli wrote:
> Dylan Jay wrote:
>> Hi,
>>
>> The manual is now uploaded to the knowledgebase area[1]. I'm assuming
>> that the redesign will get rid of the authors attributions as that no
>> longer makes sense right? If not I'll get Mikko to reupload it as it's
>> mainly his work.

Great work! Congrats! I thought I'd never see this done.

>> All the code for uploading will be in the buildout in
>> collective.developermanual shortly. Next step will be to setup regular
>> reuploads every night. Of course if anyone wants to contribute to the
>> manual just read [2]

Is it possible to make the manual non-editable for non-privileged users 
so nobody starts editing its contents TTW by mistake?

>> [...]
> 
>   - As Alex said, it's probably better as a manual than a kb article. 
> This really ought to be the basis for "the" manual for Plone development 
> in general.

The reason I suggested to leave this collective.developermanual in the 
KB for is mainly the difference in contribution policies between the 
manuals and the KB area. I know Mikko and many others want this manual 
to be freely editable and without any QA review process, and that it 
will potentially contain incomplete draft stuff, so either we:

a) Make an exception to the manuals area policies and allow this 
collective.developermanual to live there. This would mean that we would 
have a manual in the manuals area that wouldn't need any contributor 
agreement to be edited, but only collective rights access, and so we 
would have to be very careful about copyright confusions.

b) Leave it in the KB and don't break the main policies.

Please keep in mind that the KB, at least from my point of view, is 
*not* designed to be a second-rank, low-quality documentation area. It's 
just a solution to allow people who want to contribute free-form 
documentation without having to fight with the manuals structure.


>   - We shouldn't call it 'collective.developermanual'. That's the name 
> of a Python package where we put some reST source code. It has no 
> meaning to the intended audience and it's a terrible title. I'd just 
> call it the "Plone Python Development Manual" or some such.

I agree. Should we call up a small poll on the title of this manual?

-- israel


------------------------------------------------------------------------------
Throughout its 18-year history, RSA Conference consistently attracts the
world's best and brightest in the field, creating opportunities for Conference
attendees to learn about information security's most important issues through
interactions with peers, luminaries and emerging and established companies.
http://p.sf.net/sfu/rsaconf-dev2dev
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.