[Framework-Team] Re: Fwd: Including a Documentation section in each PLIP
Israel Saeta Pérez
dukebody at gmail.com
Sat Nov 15 18:28:29 UTC 2008
On Sat, Nov 15, 2008 at 6:01 PM, Wichert Akkerman wrote:
>> > I would much rather see the equivalent of the what-is-new-in-python-x.y
>> > documents: a thorough explanation of every change, its rationale, and
>> > the inpact that has on both existing and new code. That would then be a
>> > very useful starting point for the documentation team to update/extend
>> > other documentation.
> Israel Saeta wrote:
>> If the documentation has to wait for version releases it will always
>> be behind code, which leads (among other causes) to the actual state
>> of some areas of the plone.org documentation: outdated. Of course the
>> documentation team has great responsibility here, but trying to keep
>> code as important as code will help.
Wichert Akkerman wrote:
> You misunderstood my point. What I want to see is for each PLIP to have
> the equivalent of a section of the what-is-new-in-python-x.y documents.
> That does not require waiting for a release.
Uh yes you're right I've misunderstood you, my apologies. Maybe I'm
behaving in a bit too defensive way here, sorry.
I would be ok with any text explaining the impact of the PLIP in the
way we develop with, customize, or manage Plone. Links to existing
documentation that would become obsolete could be optional.
Some trivial examples:
Inline editing will be disabled by default. Update User Manual
Theming resources based on base_properties.props will become
deprecated in favour of zrt resources.
More information about the Framework-Team