[Plone-docs] collective-docs on plone.org

[Dylan Jay]

Hi,

I noticed mikko removed the conversion code from collective-docs that
could upload it to plone.org.

I think using read-the-docs is great but I disagree that we shouldn't
also have an up to date copy on plone.org.
The reason being that newbies might use plone.org search to find
documentation or a google search of site:plone.org to try and find
answers.

Other than the technical issue of how to keep the docs in sync inside
plone, is there any reason not to have this manual duplicated on
plone.org?

---
Dylan Jay
Technical Solutions Manager
PretaWeb: Multisite Performance Support
P: [phone] | M: [phone] | twitter.com/djay75 | linkedin.com/
in/djay75

[Jean Jordaan]

Post by Dylan Jay
I think using read-the-docs is great but I disagree that we shouldn't
also have an up to date copy on plone.org.

I agree that we should also have an up to date copy on plone.org.

It's just plain weird that the documentation for Plone is not on plone.org.
Is this the case for any other project of similar stature?

[Mikko Ohtamaa]

Post by Jean Jordaan

Post by Dylan Jay
I think using read-the-docs is great but I disagree that we shouldn't
also have an up to date copy on plone.org.

Please feel free to set up updater. There was no automatic update and
manual update was pain. plone.org docs were outdated all the time.

For searching it's better than docs are in one place Google finds them.

-Mikko

Post by Jean Jordaan
I agree that we should also have an up to date copy on plone.org.
It's just plain weird that the documentation for Plone is not on plone.org.
Is this the case for any other project of similar stature?
--
jean                                              . .. .... //\\\oo///\\
------------------------------------------------------------------------------
Ridiculously easy VDI. With Citrix VDI-in-a-Box, you don't need a complex
infrastructure or vast IT resources to deliver seamless, secure access to
virtual desktops. With this all-in-one solution, easily deploy virtual
desktops for less than the cost of PCs and save 60% on VDI infrastructure
costs. Try it free! http://p.sf.net/sfu/Citrix-VDIinabox
_______________________________________________
Plone-docs mailing list
https://lists.sourceforge.net/lists/listinfo/plone-docs

[Dylan Jay]

On Wed, Jan 11, 2012 at 9:26 AM, Jean Jordaan

Post by Dylan Jay
I think using read-the-docs is great but I disagree that we
shouldn't
also have an up to date copy on plone.org.

Please feel free to set up updater. There was no automatic update and
manual update was pain. plone.org docs were outdated all the time

I'll try setting up something in the plone.org buildout.

[Jon Stahl]

Post by Dylan Jay

On Wed, Jan 11, 2012 at 9:26 AM, Jean Jordaan

Post by Dylan Jay
I think using read-the-docs is great but I disagree that we
shouldn't
also have an up to date copy on plone.org.

Please feel free to set up updater. There was no automatic update and
manual update was pain. plone.org docs were outdated all the time

I'll try setting up something in the plone.org buildout.

Thanks, Dylan. I agree that we need to have our best docs findable
via Plone.org.

:jon

[Dylan Jay]

Post by Jon Stahl

Post by Dylan Jay

On Wed, Jan 11, 2012 at 9:26 AM, Jean Jordaan

Post by Dylan Jay
I think using read-the-docs is great but I disagree that we
shouldn't
also have an up to date copy on plone.org.

Please feel free to set up updater. There was no automatic update and
manual update was pain. plone.org docs were outdated all the time

I'll try setting up something in the plone.org buildout.

Thanks, Dylan. I agree that we need to have our best docs findable
via Plone.org.

1. the funnelweb approach that was used with the collective docs before (what were the limitations with this, Dylan?)

It needed to be hooked up to a cron script, probably on the plone.org
server itself. The current code reuploaded it on every sync which is a
bit nasty for plone's zodb but I can fix that.
It takes 10min + to run so would be updated daily.
Also we'd need it to run sphinx daily and that involves running code
from the collective on the server each day. If its the plone.org
server that could be a security problem. Instead I could get it to
crawl read the docs but that involves bandwidth each day.

2. creating something that lets us submit to Plone a list of URLs to be fulltext-indexed with a getURL that goes offsite, and making the sphinx build call this for the set of generated documentation

So you mean that docs aren't stored in plone? just indexed in plone
and the user redirected. Downside of that someone using google to
search and then preferring plone.org results.
You'd also need a crawler since the docs are spilt into many urls.

Other ideas?

Some kind of fs view mounted in the plone.org zodb. But I don't know
any that will automatically update the catalog when the content
changes.

David
----------
David Glick
Web Developer
206.286.1235x32
Groundwire Consulting is here.
http://groundwire.org/about/FAQ-gw-consulting