Re: 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]> |
On 2009-08-19, David Hostetler <[email protected]> wrote: > --===============2821822544495789800== > Content-Type: multipart/alternative; boundary=001485f778da151103047180bc97 > > --001485f778da151103047180bc97 > Content-Type: text/plain; charset=UTF-8 > Content-Transfer-Encoding: quoted-printable > > I'd suggest not having any specific information on that landing page at all= > , > if in fact it's not going to ever host anything useful. The example you > described is itself information that can and will get stale, compelling > someone to maintain it, even if on a very low frequency. > > Rather, I'd suggest simply redirecting to a page back on plone.org that > gives the short summary you suggested, along with a few relevant links to > direct people further. That page can thus be maintained normally, like all > other plone.org content. OK That's a great idea, thanks! I whip up a page in http://plone.org/documentation that we can all edit, then redirect to it. > regards, > > -hoss > > David Hostetler > [email protected] > > > On Wed, Aug 19, 2009 at 11:48, Alex Clark <[email protected]> wrote: > >> 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 he= > ll >> 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=E2=80=A6 >> 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 =C2=B7 http://aclark.net >> Buy Practical Plone 3: http://tinyurl.com/practical-plone >> >> >> >> -------------------------------------------------------------------------= > ----- >> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-D= > ay >> trial. Simplify your report design, integration and deployment - and focu= > s >> 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 >> > > --001485f778da151103047180bc97 > Content-Type: text/html; charset=UTF-8 > Content-Transfer-Encoding: quoted-printable > > I'd suggest not having any specific information on that landing page at= > all, if in fact it's not going to ever host anything useful.=C2=A0 The= > example you described is itself information that can and will get stale, c= > ompelling someone to maintain it, even if on a very low frequency.<br> > ><br>Rather, I'd suggest simply redirecting to a page back on <a href=3D= > "http://plone.org">plone.org</a> that gives the short summary you suggested= > , along with a few relevant links to direct people further.=C2=A0 That page= > can thus be maintained normally, like all other <a href=3D"http://plone.or= > g">plone.org</a> content.<br> > ><br>regards,<br><br>-hoss<br><br>David Hostetler<br><a href=3D"mailto:negat= > [email protected]">[email protected]</a><br><br><br><div class=3D"gmail_= > quote">On Wed, Aug 19, 2009 at 11:48, Alex Clark <span dir=3D"ltr"><<a h= > ref=3D"mailto:[email protected]">[email protected]</a>></span> wrote:<br= >> > ><blockquote class=3D"gmail_quote" style=3D"border-left: 1px solid rgb(204, = > 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">Hi all,<br> ><br> > I've got a maintenance scheduled for tonight and cleaning up<br> > is on the brain. To that end I asked Hanno in #plone-framework<br> > about <a href=3D"http://api.plone.org" target=3D"_blank">api.plone.org</a> = > and he said:<br> > =C2=A0 =C2=A011:20 < aclark> hannosch: speaking of Plone, is there a= > ny chance in hell<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0that <a href=3D"http://api.plone.org/" target= >=3D"_blank">http://api.plone.org/</a> will<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0ever see anything useful or should we just turn= > it off?<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0I'd love to think we could put up<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0some sphinx docs or something there for Plone 4= >=E2=80=A6<br> > =C2=A0 =C2=A011:20 <@hannosch> it won't ever show anything usefu= > l<br> > =C2=A0 =C2=A011:20 <@hannosch> there's no Plone API that can be = > exctracted from the code<br> > =C2=A0 =C2=A011:21 <@hannosch> you either need to look at the full c= > ode or follow a specific<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0tutorial on <a href=3D"http://plone.org/docs" t= > arget=3D"_blank">plone.org/docs</a><br> > =C2=A0 =C2=A011:21 <@hannosch> you cannot retrofit an API onto this = > beast anymore<br> ><br> > So I'd suggest we turn it off and end the confusion for good! Thoughts?= ><br> > Further, it would probably make sense to leave a note saying:<br> > =C2=A0 =C2=A0Please see the Zope 2 Sphinx docs here: <a href=3D"http://doc= > s.zope.org/zope2/zdgbook/source/" target=3D"_blank">http://docs.zope.org/zo= > pe2/zdgbook/source/</a><br> > =C2=A0 =C2=A0and then look in <a href=3D"http://plone.org/documentation" t= > arget=3D"_blank">http://plone.org/documentation</a> for specific things.<br= >> ><br> > However, we'll need to be very careful about that as Hanno points out:<= > br> > =C2=A0 =C2=A011:33 <@hannosch> the Zope2 looks nice, but it tells yo= > u to develop Zope2<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0in the 1990-style. I wouldn't want to point= > anyone to it<br> > =C2=A0 =C2=A011:33 <@hannosch> some of the stuff about security and = > the catalog is still<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0the same, but dtml, python scripts, the OFS nah= ><br> ><br> > Maybe something like:<br> > =C2=A0 =C2=A0Please see the relevant Zope 2 Sphinx docs here: <a href=3D"h= > ttp://docs.zope.org/zope2/zdgbook/source/" target=3D"_blank">http://docs.zo= > pe.org/zope2/zdgbook/source/</a><br> > =C2=A0 =C2=A0including:<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- TAL<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- Security<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- Catalog<br> > =C2=A0 =C2=A0But you can ignore:<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- DTML<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- OFS<br> > =C2=A0 =C2=A0and then look in <a href=3D"http://plone.org/documentation" t= > arget=3D"_blank">http://plone.org/documentation</a> for help with:<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- Installing add-ons<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- Writing filesystem products<br> > =C2=A0 =C2=A0 =C2=A0 =C2=A0- Etc.<br> > would do it? Anyway, let me know! My feeling is that anything is better tha= > n outdated<br> > and useless docs at this point (looking for a flurry of +1s here please ;-)= > .<br> ><br> > Alex<br> ><br> > --<br> > Alex Clark =C2=B7 <a href=3D"http://aclark.net" target=3D"_blank">http://ac= > lark.net</a><br> > Buy Practical Plone 3: <a href=3D"http://tinyurl.com/practical-plone" targe= > t=3D"_blank">http://tinyurl.com/practical-plone</a><br> ><br> ><br> > ---------------------------------------------------------------------------= > ---<br> > Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day= ><br> > trial. Simplify your report design, integration and deployment - and focus = > on<br> > what you do best, core application coding. Discover what's new with<br> > Crystal Reports now. =C2=A0<a href=3D"http://p.sf.net/sfu/bobj-july" target= >=3D"_blank">http://p.sf.net/sfu/bobj-july</a><br> > _______________________________________________<br> > Plone-docs mailing list<br> ><a href=3D"mailto:[email protected]">[email protected]= > forge.net</a><br> ><a href=3D"https://lists.sourceforge.net/lists/listinfo/plone-docs" target= >=3D"_blank">https://lists.sourceforge.net/lists/listinfo/plone-docs</a><br> ></blockquote></div><br> > > --001485f778da151103047180bc97-- > > > --===============2821822544495789800== > Content-Type: text/plain; charset="us-ascii" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Content-Disposition: inline > > ------------------------------------------------------------------------------ > 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 > --===============2821822544495789800== > Content-Type: text/plain; charset="us-ascii" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Content-Disposition: inline > > _______________________________________________ > Plone-docs mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/plone-docs > > --===============2821822544495789800==-- > > -- 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