11 Dec 2009 Meeting - summary
Israel Saeta Pérez <[email protected]>
| Newsgroups | gmane.comp.web.zope.plone.documentation |
|---|---|
| Message-ID | <[email protected]> |
Here's the summary I promised. Please note this is just what we talked about during the last meeting - there's a lot more to do with documentation, just check http://dev.plone.org/plone/report/25 ! I tried to be as concise as possible so, if you feel I'm missing something important, don't hesitate to reply to this thread! What has been recently done? ============================= * Steve upgraded Plone.org to use Plone Help Center == 3.0b2 and migration scripts run. * A KnowledgeBase (KB) was created at: http://plone.org/documentation/kb/ The KB is meant to be like the collective for documentation (clear policies will come shortly). The other part of the documentation, Plone manuals (or core docs, or any other fancy name), will live right in http://plone.org/documentation/. * Veda and Anne moved docs between KB and manuals following the topic section assessments in: http://www.coactivate.org/projects/plone-documentation Redirections should be managed automagically by Plone 3. However, there were some technical problems moving some of them, since manuals or howtos can't be pasted into manuals, and some elements are kind of broken and can't be deleted easily to create manual redirects using /@@manage-aliases. What's being done? ================== * Jon Stahl is working on a document to describe the policies for KB and manuals. They will be a modified version of the WordPress Terms Of Service, using CC-BY-NC. If I'm not wrong, they are already sent to the Plone Foundation, which will meet next Thursday. We'll keep you updated about this. An _outline_ of this policies written by Steve is attached to this mail. * Steve will immplement these policies via plone.org permissions and workflows as soon as they're accepted. * Veda and Limi agreed upon the final new UI for the plone.org documentation. Limi is working on the final implementation in HTML/CSS. He will try to get it done by this weekend. Next steps =========== Since there were problems moving docs back and forth, some of the redirections aren't working properly. An example is the Portlets Developer Manual: http://plone.org/documentation/manual/portlets-developer-manual http://plone.org/documentation/manual/developer-manual/to-be-inserted-in-the-manual/portlets * In some cases it's not possible to delete the old items using the Plone interface, so we have to write down those who refuse to be deleted and send the list to an admin (e.g. Steve) to delete them "manually". * Create redirections for those items that weren't automagically redirected. If you stumble on one of these, please file a ticket in http://dev.plone.org/plone, Documentation component, and an editor will try to solve it as soon as possible. * Reorganize the sections in the different manuals. The Developer Manual at http://plone.org/documentation/manual/developer-manual deserves special care. I (Israel) can work on this one with cbess, dylan and mikko. * Anne will write a document about what do we want the manuals to be, regarding to consistency, up2date-ness, etc. * Since there will only be manuals in the section under editors control, we decided to leave the "editors per section" model and move to a "manual owners" one. Perhaps we should discuss how this will work? Future ====== * Update documentation to match Plone 4. We expect Plone 4 final in late Feb the earliest. Betas in January. I (Israel) will manage this. We're already in contact with the PLIP implementers to help us write proper documentation. -- israel ------------------------------------------------------------------------------ Return on Information: Google Enterprise Search pays you back Get the facts. http://p.sf.net/sfu/google-dev2dev _______________________________________________ Plone-docs mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/plone-docs
kb-manuals-policy-outline.txt
(text/plain, 886 B)
* KB rights will be modeled on collective; very easy to get. Folks will be able to create documents with only member rights, but will need to get doc collective rights to publish or edit others' work. Sounds decent.
* (The reason to require doc collective rights is to avoid link spam. With a top page rank, we're a serious target for link spam.)
* Application to join doc collective will be either by:
* adding a new doc
* posting a ticket to request membership
* Manual editors will be successors to editors. A much more tightly watched list, modeled on core dev. Signing a contributors agreement will be required.
* Application to become a core document editor will be by filing contrib agreement, then filing a ticket.
* Author in manual section will be "Plone Documentation Team" — not individual who created doc. Credits via contributors.