Documentation:

the new deal

Current

developer.plone.org

organic collection of different docs

plone.org/documentation

a potpourri of all kind of docsmostly out of date

There's more!

plone user manual

good, but not many people know it

add-ons

some have nice docs, eg. PFGothers are well, crap

It is time for a changeSo we started to prepareand drink coco-loco !

Make it happen

Stroopwafel Sprint

Cake-driven documentationidentified gaps in the documentationa plan for versioning.plan: consolidate all documentationthe mindmap to rule all mindmaps

Cake is goodinfrastructure for multilingualselect a correct licensedisabled knowledge base on plone.org

Cathedral Sprinttime to take the gloves offget on people's nerves(aka, tell developers to write docs)

DocSprint MunichThanks again Max and Alexander !

testing docs on humans (animal testing is bad, mmmkay)asking professional writers for help, thanks again @LMUcreate structurecopy docs to the right place in the new setup.

fix broken linksstart pulling external docs(git sparse is cool...)new docs themePDF creation via LaTeX

Fixed around 368 warning and bugsdiscussed writing guidelinescleaning up tickets from the currentdeveloper.documentation

Beer and Wine Sprint

more fixing of links, typos and so onstart add missing parts ('new collections')writing guidelines for add-on writers

First importantchange

Licensemoving docs from collective to plonechange license from gpl to creativecommonsCC 4.0 BY. kthxbye!people have to sign contributoragreement

docs.plone.org

basic features

one landing page for all docsincluding end users, site admins,deployers, developers, core devs

fancy stuffdifferent plone versionsdifferent languagestransifex integrationscreen shot integration

collecting moredocs

include docs for add-onsworking pdf creationat the moment, we have around2000 pages of a4 pdf

How it workstwo repositories

repository one[documentation]

just the plain rst filesa branch for every versionper language directories

repositorytwo [papyrus]

Is where the magichappenstransifexpull in external docsrobot screenshots

Qualityinsurance

No direct commits tomaster or brancheswe only do pullrequests with reviewsif someone commitswithout a pull requestwe will revert!!LaTeX is a harsh critic...

Guidelinesfor writing

add-ondocumentation

NO MORE PEP8syntactic linebreaks;think of thetranslatorsdocumentation isnot "look at thecode"yes, we've tested onreal devs

Helpertools

mr gutenbergsublime textsearchfirefox searchadd-onworking on abetter onlineeditor

Futureplans

hook docs intojenkinstestPDF/Epub/HTMLgenerationwant PLIPs?Write docs!

Moreplans

have morethemes,fitting withthe versionhavesite-specificdocs, withscreenshotsto matchrobotize allthe things

Goforthand document