Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Documentation:
the new deal
Current
developer.plone.org
organic collection of different docs
plone.org/documentation
a potpourri of all kind of docs
mo...
There's more!
plone user manual
good, but not many people know it
add-ons
some have nice docs, eg. PFG
others are well, cr...
It is time for a change
So we started to prepare
and drink coco-loco !
Make it happen
Stroopwafel Sprint
Cake-driven documentation
identified gaps in the documentation
a plan for versioning.
plan: consolidate all documentation
t...
Cake is good
infrastructure for multilingual
select a correct license
disabled knowledge base on plone.org
Cathedral Sprint
time to take the gloves off
get on people's nerves
(aka, tell developers to write docs)
DocSprint Munich
Thanks again Max and Alexander !
testing docs on humans (animal testing is bad, mmmkay)
asking professional writers for help, thanks again @LMU
create stru...
fix broken links
start pulling external docs
(git sparse is cool...)
new docs theme
PDF creation via LaTeX
Fixed around 368 warning and bugs
discussed writing guidelines
cleaning up tickets from the current
developer.documentation
Beer and Wine Sprint
more fixing of links, typos and so on
start add missing parts ('new collections')
writing guidelines for add-on writers
First important
change
License
moving docs from collective to plone
change license from gpl to creative
commons
CC 4.0 BY. kthxbye!
people have t...
docs.plone.org
basic features
one landing page for all docs
including end users, site admins,
deployers, developers, core ...
fancy stuff
different plone versions
different languages
transifex integration
screen shot integration
collecting more
docs
include docs for add-ons
working pdf creation
at the moment, we have around
2000 pages of a4 pdf
How it works
two repositories
repository one
[documentation]
just the plain rst files
a branch for every version
per language directories
repository
two [papyrus]
Is where the magic
happens
transifex
pull in external docs
robot screenshots
Quality
insurance
No direct commits to
master or branches
we only do pull
requests with reviews
if someone commits
without...
Guidelines
for writing
add-on
documentation
NO MORE PEP8
syntactic linebreaks;
think of the
translators
documentation is
n...
Helper
tools
mr gutenberg
sublime text
search
firefox search
add-on
working on a
better online
editor
Future
plans
hook docs into
jenkins
test
PDF/Epub/HTML
generation
want PLIPs?
Write docs!
More
plans
have more
themes,
fitting with
the version
have
site-specific
docs, with
screenshots
to match
robotize all
the th...
Go
forth
and document
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Plog2014 doc the-new_deal
Upcoming SlideShare
Loading in …5
×

Plog2014 doc the-new_deal

343 views

Published on

talk on Plone documentation, Plone Open Garden 2014. Sorry for no/bad layout, it was using hovercraft (prezi-style) before and this is printed via mozilla...

Published in: Software, Technology

Plog2014 doc the-new_deal

  1. 1. Documentation: the new deal
  2. 2. Current developer.plone.org organic collection of different docs plone.org/documentation a potpourri of all kind of docs mostly out of date
  3. 3. There's more! plone user manual good, but not many people know it add-ons some have nice docs, eg. PFG others are well, crap
  4. 4. It is time for a change So we started to prepare and drink coco-loco !
  5. 5. Make it happen
  6. 6. Stroopwafel Sprint
  7. 7. Cake-driven documentation identified gaps in the documentation a plan for versioning. plan: consolidate all documentation the mindmap to rule all mindmaps
  8. 8. Cake is good infrastructure for multilingual select a correct license disabled knowledge base on plone.org
  9. 9. Cathedral Sprint time to take the gloves off get on people's nerves (aka, tell developers to write docs)
  10. 10. DocSprint Munich Thanks again Max and Alexander !
  11. 11. testing docs on humans (animal testing is bad, mmmkay) asking professional writers for help, thanks again @LMU create structure copy docs to the right place in the new setup.
  12. 12. fix broken links start pulling external docs (git sparse is cool...) new docs theme PDF creation via LaTeX
  13. 13. Fixed around 368 warning and bugs discussed writing guidelines cleaning up tickets from the current developer.documentation
  14. 14. Beer and Wine Sprint
  15. 15. more fixing of links, typos and so on start add missing parts ('new collections') writing guidelines for add-on writers
  16. 16. First important change
  17. 17. License moving docs from collective to plone change license from gpl to creative commons CC 4.0 BY. kthxbye! people have to sign contributor agreement
  18. 18. docs.plone.org basic features one landing page for all docs including end users, site admins, deployers, developers, core devs
  19. 19. fancy stuff different plone versions different languages transifex integration screen shot integration
  20. 20. collecting more docs include docs for add-ons working pdf creation at the moment, we have around 2000 pages of a4 pdf
  21. 21. How it works two repositories
  22. 22. repository one [documentation] just the plain rst files a branch for every version per language directories
  23. 23. repository two [papyrus] Is where the magic happens transifex pull in external docs robot screenshots
  24. 24. Quality insurance No direct commits to master or branches we only do pull requests with reviews if someone commits without a pull request we will revert!! LaTeX is a harsh critic...
  25. 25. Guidelines for writing add-on documentation NO MORE PEP8 syntactic linebreaks; think of the translators documentation is not "look at the code" yes, we've tested on real devs
  26. 26. Helper tools mr gutenberg sublime text search firefox search add-on working on a better online editor
  27. 27. Future plans hook docs into jenkins test PDF/Epub/HTML generation want PLIPs? Write docs!
  28. 28. More plans have more themes, fitting with the version have site-specific docs, with screenshots to match robotize all the things
  29. 29. Go forth and document

×