With the new PloneHelpCenter-based documentation area, plone.org now has a process for easy authoring and quality assurance of contributed documentation - and lifecycle management of that content.
PloneHelpCenter makes it easy to contribute and review documentation, and we plan to expand the functionality continuously as needed.
I would like to thank all the involved for making this a reality - especially those helping with writing the software and reviewing the exsisting content.
It's impossible to mention everybody that has helped, but special thanks to Martin Aspeli (optilude), Joel Burton and Raphael Ritz for reviewing oodles of content - Christian Heimes (Tiran), Dorneles Treméa, Nate Aune, Daniel Nouri, Tim Terlegard, Edward Muller, Jean-Paul Ladage, Jens Klein and the Plone Solutions team for help with writing PloneHelpCenter itself. And of course everyone that has contributed feedback during the beta phase. You rock!
If I forgot your name from the list, please remind me. :)
Now, it's your turn - contribute FAQs, How-tos, Tutorials, Links, Resolved Error Messages and Glossary Entries!
On behalf of the Documentation Team,
— Alexander Limi // Plone Solutions
PS: The old documentation area is available at /documentation-old, but will be gradually removed.
Quick Guidelines for contributing
For the impatient, here's the bare minimum you should know:
- You need to be logged in.
- There are several different documentation types, most are self-explanatory, but pay attention to the difference between a How-to and a Tutorial (explained here).
- To add a piece of documentation/help, go into the relevant section,
make sure there isn't already an existing entry about what
you want to add,
and use the button at the top right to add (normally says
Add FAQor similar).
- Add your content, and save it. This edit/view cycle can be performed as many times as you like, until you are happy with the result.
- Make sure you
Submityour document for publication when you are done — top right pulldown in the content area.
- A reviewer will then pick up the document, and publish it unless the content needs to be improved.
- If somebody adds comments to your entry later, you will be notified by e-mail.