Re: collective-docs on plone.org

Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]> Wed, 18 Jan 2012 09:22:28 +1100
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <3363898408479982471@unknownmsgid>
On 18/01/2012, at 7:10 AM, "David Glick (GW)" <[email protected]> wrote:

>
> On Jan 17, 2012, at 10:52 AM, Jon Stahl wrote:
>
>> On Wed, Jan 11, 2012 at 2:35 AM, Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]> wrote:
>>>
>>> On 11/01/2012, at 9:06 PM, Mikko Ohtamaa wrote:
>>>
>>>> On Wed, Jan 11, 2012 at 9:26 AM, Jean Jordaan
>>>> <[email protected]> wrot=
>>>> e:
>>>>> On Wed, Jan 11, 2012 at 1:09 PM, Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]>
>>>>> wrote:
>>>>>> 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.
>>
>
> This concern is the main reason I haven't rushed to delete the existing Dexterity docs on plone.org now that we have a more maintainable version on readthedocs. We obviously do need to deal with that sooner rather than later though so that we don't have 2 out of sync copies of the docs. Options I can think of:
>
> 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
> [email protected]
> 206.286.1235x32
>
> Groundwire Consulting is here.
>
> http://groundwire.org/about/FAQ-gw-consulting
>
>

------------------------------------------------------------------------------
Keep Your Developer Skills Current with LearnDevNow!
The most comprehensive online learning library for Microsoft developers
is just $99.99! Visual Studio, SharePoint, SQL - plus HTML5, CSS3, MVC3,
Metro Style Apps, more. Free future releases when you subscribe now!
http://p.sf.net/sfu/learndevnow-d2d