Let's turn off api.plone.org.

Alex Clark <[email protected]>
Newsgroups gmane.comp.web.zope.plone.documentation
Organization ACLARK.NET, LLC
Message-ID <[email protected]>
Hi all, 

I've got a maintenance scheduled for tonight and cleaning up
is on the brain. To that end I asked Hanno in #plone-framework
about api.plone.org and he said:
    11:20 < aclark> hannosch: speaking of Plone, is there any chance in hell 
        that http://api.plone.org/ will
        ever see anything useful or should we just turn it off? 
        I'd love to think we could put up
        some sphinx docs or something there for Plone 4…
    11:20 <@hannosch> it won't ever show anything useful
    11:20 <@hannosch> there's no Plone API that can be exctracted from the code
    11:21 <@hannosch> you either need to look at the full code or follow a specific 
        tutorial on plone.org/docs
    11:21 <@hannosch> you cannot retrofit an API onto this beast anymore

So I'd suggest we turn it off and end the confusion for good! Thoughts? 
Further, it would probably make sense to leave a note saying:
    Please see the Zope 2 Sphinx docs here: http://docs.zope.org/zope2/zdgbook/source/
    and then look in http://plone.org/documentation for specific things.

However, we'll need to be very careful about that as Hanno points out:
    11:33 <@hannosch> the Zope2 looks nice, but it tells you to develop Zope2 
        in the 1990-style. I wouldn't want to point anyone to it
    11:33 <@hannosch> some of the stuff about security and the catalog is still
        the same, but dtml, python scripts, the OFS nah

Maybe something like:
    Please see the relevant Zope 2 Sphinx docs here: http://docs.zope.org/zope2/zdgbook/source/
    including:
        - TAL
        - Security
        - Catalog
    But you can ignore:
        - DTML
        - OFS
    and then look in http://plone.org/documentation for help with:
        - Installing add-ons
        - Writing filesystem products
        - Etc.
would do it? Anyway, let me know! My feeling is that anything is better than outdated 
and useless docs at this point (looking for a flurry of +1s here please ;-).

Alex

-- 
Alex Clark · http://aclark.net
Buy Practical Plone 3: http://tinyurl.com/practical-plone


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day 
trial. Simplify your report design, integration and deployment - and focus on 
what you do best, core application coding. Discover what's new with 
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Plone-docs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/plone-docs
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.