documentation guide for add-ons

sven <[email protected]>
Newsgroups gmane.comp.web.zope.plone.devel
Message-ID <[email protected]>
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

during the beer and wine sprint we were working on our documentation as
you already may know.
One of our goals is/was it to streamline the complete documentation as
far as possible.

We know the new guide will create extra work, because some of you will
have to change their docs, we apologize for the extra work, but this
will pay of in the long run, also keep in mind the big picture is Plone,
with following the guide, it will be easy possible to include your
add-on documentation into the soon upcoming docs.plone.org and with
this, your docs will also show up if you do a search on the soon
upcoming plone.org.
We also starting working on a buildout recipe which will create some
boilerplate to make documentation easier for your
[github.com/plone/mr.gutenberg].

We worked out this guide with lots of help from the Documentation Team
IT of the LMU [Ludwig Maximilian University of Munich], further was it
reviewed during the sprint, and we fixed some points according to the
input we got.

Here is the guide:
https://github.com/plone/documentation/blob/master/about/documentation_styleguide_addons.rst

If you have questions or other input, please write to
[email protected]

Cheers,

Sven
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.14 (GNU/Linux)
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/

iQEcBAEBAgAGBQJTO+bSAAoJEMipVdWfKjFj1y4IAKaD0Ba6+dgmvb7MnDd6byb2
c2q9cWvKJn1djkL6cnwT1eGK9n33Vi4/f+secovP4HcRfeybcuOZlWx4XgkYUj7B
58jKZdDIXKT3r8yT6DuT5OEJbTcXvrl5opXx8DV6By58pkk8A/oIBvLjTyy/2qsB
Uu2TwEIKiIcPC1ymgZSpKgpNb+nf8NTOiWJ6d8zvOVljOxXwhYV/OSXsaI45dtaV
8CEtAjeanxafjbG0np4CU/kdGl3W5HgPAFbN/WOe/qFVYbRZer7DkdolCFwrEAVa
qDARabG1GuFjDYtTGGAKyGU1UV8wNXsHJHbX4ovebB0qzd2ihgaTWlhhpRgGueQ=
=gpcl
-----END PGP SIGNATURE-----

------------------------------------------------------------------------------
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.