[Plone-docs] Collective developer manual now ready to be plone.orgified

Discussion:

Mikko Ohtamaa

2010-04-19 06:49:49 UTC

Hi,

Now the work to upload Sphinx based documentation, namely
collletive.developermanual, is in a stage it is useful.

I created a demo site here were I uploaded collective.developermanual to
vanilla Plone site with Plone Help Center only installed:

http://collective-docs.mfabrik.com/

The process itself is described here:

http://collective-docs.mfabrik.com/documentation/introduction/developermanual.html

If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.

Cheers,
Mikko

-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.

Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com

--
View this message in context: http://n2.nabble.com/Collective-developer-manual-now-ready-to-be-plone-orgified-tp4923820p4923820.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Martin Aspeli

2010-04-19 07:01:01 UTC

Permalink

*clap* *clap* *clap* *clap* *clap* *clap*

Awesome work, Mikko :-)

Post by Mikko Ohtamaa
If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.

I put you in the doc team group. In fact, I'm surprised you weren't
there already. ;)

Martin

Martin

Alexander Limi

2010-04-19 07:02:44 UTC

Permalink

Oh, and the second thing we might consider is to strip the .html suffix when
uploading them into Plone, since nothing else has that on the site. These
are minor details, though. :)

This is great! Can't wait to see the "proper" version go live on plone.org.
Had a quick peek, and the only issue I found was a stray node called
http://collective-docs.mfabrik.com/documentation/static-1
apart from that, it looks great! Thanks for doing this.
Alexander
On Sun, Apr 18, 2010 at 11:49 PM, Mikko Ohtamaa <

Post by Mikko Ohtamaa
Hi,
Now the work to upload Sphinx based documentation, namely
collletive.developermanual, is in a stage it is useful.
I created a demo site here were I uploaded collective.developermanual to
http://collective-docs.mfabrik.com/
http://collective-docs.mfabrik.com/documentation/introduction/developermanual.html
If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.
Cheers,
Mikko
-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.
Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com
--
http://n2.nabble.com/Collective-developer-manual-now-ready-to-be-plone-orgified-tp4923820p4923820.html
Sent from the Documentation Team mailing list archive at Nabble.com.
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

--
Alexander Limi · http://limi.net

Dylan Jay

2010-04-19 07:53:42 UTC

Permalink

Post by Alexander Limi
Oh, and the second thing we might consider is to strip the .html
suffix when uploading them into Plone, since nothing else has that
on the site. These are minor details, though. :)

It was on my list of todo's for the funnelweb code to clean out file
extensions from names by default. This code is now in http://github.com/djay/transmogrify.siteanalyser
if anyone wants to get in before me :)
The _static and search.html pages will also be filtered out.

Post by Alexander Limi
This is great! Can't wait to see the "proper" version go live on
plone.org. Had a quick peek, and the only issue I found was a stray
http://collective-docs.mfabrik.com/documentation/static-1
…apart from that, it looks great! Thanks for doing this.
— Alexander
Hi,
Now the work to upload Sphinx based documentation, namely
collletive.developermanual, is in a stage it is useful.
I created a demo site here were I uploaded
collective.developermanual to
http://collective-docs.mfabrik.com/
http://collective-docs.mfabrik.com/documentation/introduction/developermanual.html
If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.
Cheers,
Mikko
-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.
Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com
--
View this message in context: http://n2.nabble.com/Collective-developer-manual-now-ready-to-be-plone-orgified-tp4923820p4923820.html
Sent from the Documentation Team mailing list archive at Nabble.com.
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs
--
Alexander Limi · http://limi.net
--
Alexander Limi · http://limi.net
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

Alexander Limi

2010-04-19 07:01:24 UTC

Permalink

This is great! Can't wait to see the "proper" version go live on plone.org.
Had a quick peek, and the only issue I found was a stray node called
"_static" at:

http://collective-docs.mfabrik.com/documentation/static-1

apart from that, it looks great! Thanks for doing this.

Alexander

On Sun, Apr 18, 2010 at 11:49 PM, Mikko Ohtamaa <

--
Alexander Limi · http://limi.net

Alex Clark

2010-04-21 01:25:00 UTC

Permalink

Post by Mikko Ohtamaa
Hi,
Now the work to upload Sphinx based documentation, namely
collletive.developermanual, is in a stage it is useful.

Congrats! Nice work.

Post by Mikko Ohtamaa
I created a demo site here were I uploaded collective.developermanual to
http://collective-docs.mfabrik.com/
http://collective-docs.mfabrik.com/documentation/introduction/developermanual.html
If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.

So basically the process is to run some transmogrifier "rules" (or whatever
they are called I've never used it) on the sphinx docs and that just does
phc.referencemanual.obj.setText(sphinx_generated_html) (or whatever the accessor is) ?

This is my favorite:

http://collective-docs.mfabrik.com/documentation/referencemanual-all-pages

:-)

Post by Mikko Ohtamaa
Cheers,
Mikko
-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.
Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com

--
Alex Clark · http://aclark.net
Author of Plone 3.3 Site Administration · http://aclark.net/plone-site-admin

Dylan Jay

2010-04-21 01:45:12 UTC

Permalink

Post by Alex Clark

Post by Mikko Ohtamaa
Hi,
Now the work to upload Sphinx based documentation, namely
collletive.developermanual, is in a stage it is useful.

Congrats! Nice work.

Post by Mikko Ohtamaa
I created a demo site here were I uploaded
collective.developermanual to
http://collective-docs.mfabrik.com/
http://collective-docs.mfabrik.com/documentation/introduction/developermanual.html
If someone puts me in docteam or grants edit access to
collective-developermanual reference manual at plone.org I can push the
manual in.

So basically the process is to run some transmogrifier "rules" (or whatever
they are called I've never used it) on the sphinx docs and that just does

pretty much. The code is from pretaweb.funnelweb, a generic website
importer for plone, which has now been split into many packages 6
packages

http://pypi.python.org/pypi?:action=search&term=funnelweb

Post by Alex Clark
phc.referencemanual.obj.setText(sphinx_generated_html) (or whatever the accessor is) ?

Not quite as clean as that but basically yes.

http://github.com/djay/transmogrify.ploneremote/blob/master/transmogrify/ploneremote/remoteschemaupdater.py

It's unfortunate that the xmlrpc doesn't consistently work for plone
api's and you have to revert to using urllib.

Mikko did some great work to add remote workflow updating (which will
be merged in soon) which also had to revert to using urllib instead of
xmlrpc.

http://github.com/miohtama/transmogrify.ploneremote/blob/master/transmogrify/ploneremote/remoteworkflowupdater.py

Post by Alex Clark
http://collective-docs.mfabrik.com/documentation/referencemanual-all-pages
:-)

Post by Mikko Ohtamaa
Cheers,
Mikko
-----
Mikko Ohtamaa
mFabrik - Freedom Delivered.
Web site - http://mfabrik.com
Mobile site - http://mfabrik.mobi
Blog - http://blog.mfabrik.com

--
Alex Clark · http://aclark.net
Author of Plone 3.3 Site Administration · http://aclark.net/plone-site-admin
------------------------------------------------------------------------------
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs