plone-docs — Discussion about the Plone documentation

Re: [Plone-docs] I don't get any message from plone-docs list

[Benedek Z. <ben...@ya...>]

Thanks, Vincent!

I've got the .po files. I could build plone4 as described, I changed only in 
plipbase.cfg to extend pil.cfg.
Concerning the e-mails I've found the problem in my stupid yahoo settings: was 
set to delete spam 'Immediately'.

Zoli



________________________________
From: Vincent Fretin <vin...@gm...>
To: Benedek Zoltan <ben...@ya...>
Cc: plo...@li...
Sent: Mon, September 13, 2010 10:14:04 AM
Subject: Re: [Plone-docs] I don't get any message from plone-docs list

On Sat, Sep 11, 2010 at 11:56 PM, Benedek Zoltan <ben...@ya...> wrote:
> Hi,
> @Balazs - I would be glad to help in translation into Hungarian, in fact is
> my native language. I've subscribed already
> to  plo...@li... , only I haven't got yet the picture. I
> saw some pages about ".po" and ".mo" files and about poedit. Could you
> please explain a bit how could I begin?
> Zoli

Hi,

I've just started a doc here:
https://svn.plone.org/svn/collective/collective.developermanual/trunk/source/i18n/contribute_to_translations.txt

It will soon appear at http://collective-docs.plone.org/i18n/
Please post to the plone-i18n mailing-list if you have any questions.

Vincent
Plone i18n team leader



      

Re: [Plone-docs] write access to i18n and l10n documents

[Israel S. P. <duk...@gm...>]

On 13/09/10 09:22, Vincent Fretin wrote:
> Hi,
>
> Is it possible to have write access to all i18n and l10n documents on plone.org.
> http://plone.org/documentation/topic/Internationalization+and+Localization
>
> I want to update them or simply remove them if all the informations
> are in the developer manual.
> My login is vincentfretin.


Hi Vincent,

I've just granted edit rights to the Plone commiters group to manuals 
("official" documentation) and added you to the documentation team group 
on plone.org. The latter should grant you add, edit and review rights on 
http://plone.org/documentation/kb.

Please contact me again if you suffer any issues.

-- israel

[Plone-docs] write access to i18n and l10n documents

[Vincent F. <vin...@gm...>]

Hi,

Is it possible to have write access to all i18n and l10n documents on plone.org.
http://plone.org/documentation/topic/Internationalization+and+Localization

I want to update them or simply remove them if all the informations
are in the developer manual.
My login is vincentfretin.

Thanks

Vincent Fretin
Plone i18n team leader

Re: [Plone-docs] I don't get any message from plone-docs list

[Vincent F. <vin...@gm...>]

On Sat, Sep 11, 2010 at 11:56 PM, Benedek Zoltan <ben...@ya...> wrote:
> Hi,
> @Balazs - I would be glad to help in translation into Hungarian, in fact is
> my native language. I've subscribed already
> to  plo...@li... , only I haven't got yet the picture. I
> saw some pages about ".po" and ".mo" files and about poedit. Could you
> please explain a bit how could I begin?
> Zoli

Hi,

I've just started a doc here:
https://svn.plone.org/svn/collective/collective.developermanual/trunk/source/i18n/contribute_to_translations.txt
It will soon appear at http://collective-docs.plone.org/i18n/
Please post to the plone-i18n mailing-list if you have any questions.

Vincent
Plone i18n team leader

[Plone-docs] I don't get any message from plone-docs list

[Benedek Z. <ben...@ya...>]

Hi,

Thanks for your answers. I don't know the reason, but I was wandering why I 
don't get any message from the mailing list neither into my inbox nor into the 
spam folder. Unfortunately I checked only now on sourceforge.

1 little problem I've found recently on plone.org first page. In chrome+firefox 
I cannot change the focus away from the presentation (dynamic widget) under the 
Plone logo by clicking to blank space. So in chrome I cannot use the keyboard to 
scroll down on the page. In firefox is working after scrolling down the 
presentation.

@Balazs - I would be glad to help in translation into Hungarian, in fact is my 
native language. I've subscribed already to  plo...@li... , 
only I haven't got yet the picture. I saw some pages about ".po" and ".mo" files 
and about poedit. Could you please explain a bit how could I begin?

Zoli


      

Re: [Plone-docs] Thank you!

[Israel S. P. <duk...@gm...>]

On 03/09/10 17:39, Eric Steele wrote:
> Docs team,
>
> Lost in all of the excitement of releasing Plone 4 and wrapping up all of the related marketing bits is the fantastic work you've all done. We threw a lot of new features at you, but you've handled them all without fail. Great work!
>

Thank you too for all the management work!

Now it's time to look forward to the 4.1 PLIPs documentation. Do the 
implementers know they have to submit documentation along with the code 
for review and what's the best way to do so?

-- israel

[Plone-docs] Thank you!

[Eric S. <em...@ps...>]

Docs team,

Lost in all of the excitement of releasing Plone 4 and wrapping up all of the related marketing bits is the fantastic work you've all done. We threw a lot of new features at you, but you've handled them all without fail. Great work!

Eric

Re: [Plone-docs] Two books to be included

[Marcos R. <mar...@in...>]

Thank you!

Regards

2010/9/3 Jon Stahl <jo...@gr...>

> Marcos-
>
> I've added these to http://plone.org/documentation/books, thanks very
> much!  (I'm going to try to make the display of books a bit nicer as well,
> stay tuned for some additional improvements.)
>
> :jon
>
>
> On Sep 2, 2010, at 6:26 AM, Marcos Romero wrote:
>
>  Dear Documentation Team:
>
> Packt Publishing has published in last May the Plone 3 Products Development
> Cookbook, by Juan Pablo Giménez (copied) and I.
>
> Although we know its "just" published, it already has some good reviews in
> Amazon and other websites, that's why we think it may be included in the
> Books section.
>
>
> http://www.amazon.com/Plone-3-3-Products-Development-Cookbook/product-reviews/1847196721/ref=cm_cr_dp_all_summary?ie=UTF8&showViewpoints=1&sortBy=bySubmissionDateDescending
>
> http://regebro.wordpress.com/2010/05/23/review-plone-3-products-development-cookbook/
> http://davisagli.com/blog/review-of-plone-3-products-development-cookbook
>
> http://rickwagner.blogspot.com/2010/06/book-review-for-plone-3-products.html
> http://joseargudo.es/en/blog/176-plone-3-products-development-cookbook.html
>
> On the other hand, as you already know, Alex Clark also published a book
> with the same publishing company.
> I've just wrote a review of it in Amazon and we think that it is a must
> regarding Plone Administration.
> http://www.amazon.com/review/R2RUZ7RV23SWVR/ref=cm_cr_rdp_perm
>
> Is it OK if we (playing the "other interested party" role) ask it to be
> also included in the Books section?
>
> Best regards
>  --
>
> *Marcos F. Romero*
> Responsable de Desarrollo
> Inter-Cultura
>
> mar...@in...
> www.inter-cultura.com
> +54 11 4542-8299
>
> ------------------------------------------------------------------------------
>
> This SF.net Dev2Dev email is sponsored by:
>
> Show off your parallel programming skills.
> Enter the Intel(R) Threading Challenge 2010.
>
> http://p.sf.net/sfu/intel-thread-sfd_______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>
>
>    *Jon Stahl*
> Senior Strategist
> jo...@gr...
> 206.286.1235x15
>
> [image: Groundwire logo]<http://groundwire.org/?utm_source=Groundwire.org%2BEmail&utm_medium=Email&utm_campaign=Logo>
>
> Sign up for Groundwire News!<http://groundwire.org/email-capture?utm_source=Groundwire.org-email&utm_medium=Email&utm_content=Sign-up-for-groundwire-news&utm_campaign=email-signature>
>
>
>


-- 
Marcos F. Romero
Responsable de Desarrollo
Inter-Cultura

mar...@in...
www.inter-cultura.com
+54 11 4542-8299

[Plone-docs] Two books to be included

[Marcos R. <mar...@in...>]

  Dear Documentation Team:

Packt Publishing has published in last May the Plone 3 Products 
Development Cookbook, by Juan Pablo Giménez (copied) and I.

Although we know its "just" published, it already has some good reviews 
in Amazon and other websites, that's why we think it may be included in 
the Books section.

http://www.amazon.com/Plone-3-3-Products-Development-Cookbook/product-reviews/1847196721/ref=cm_cr_dp_all_summary?ie=UTF8&showViewpoints=1&sortBy=bySubmissionDateDescending
http://regebro.wordpress.com/2010/05/23/review-plone-3-products-development-cookbook/
http://davisagli.com/blog/review-of-plone-3-products-development-cookbook
http://rickwagner.blogspot.com/2010/06/book-review-for-plone-3-products.html
http://joseargudo.es/en/blog/176-plone-3-products-development-cookbook.html

On the other hand, as you already know, Alex Clark also published a book 
with the same publishing company.
I've just wrote a review of it in Amazon and we think that it is a must 
regarding Plone Administration.
http://www.amazon.com/review/R2RUZ7RV23SWVR/ref=cm_cr_rdp_perm

Is it OK if we (playing the "other interested party" role) ask it to be 
also included in the Books section?

Best regards
-- 

*Marcos F. Romero*
Responsable de Desarrollo
Inter-Cultura

mar...@in... <mailto:mar...@in...>
www.inter-cultura.com <http://www.inter-cultura.com/>
+54 11 4542-8299

Re: [Plone-docs] LinguaPlone manual

[Jean J. <jea...@gm...>]

Just in case anyone else ends up here (i.e.
http://plone.293351.n2.nabble.com/LinguaPlone-manual-td359520.html ) .. 

The "documentation tracker" these days is actually the Documentation
component of the Plone tracker. To see these issues, go here: 
http://dev.plone.org/plone/query?status=assigned&status=new&status=reopened&component=Documentation&order=priority

The issue that Darci mentions is this one:
http://dev.plone.org/plone/ticket/7634

>From that issue, it seems that sadly the LinguaPlone manual has been
abandoned. 

I haven't been able to find much documentation of Plone content translation
on the web. These are what I found:
http://www.contentmanagementsoftware.info/plone-book/multilingual/multilingual-site
(short article)
http://macadames.wordpress.com/2010/02/06/plone-and-multilingual-sites/
(blog post)
-- 
View this message in context: http://plone.293351.n2.nabble.com/LinguaPlone-manual-tp359520p5486113.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] proof-reading user manual

[Balazs R. <re...@gr...>]

Hi Zoli,

Sat, 14 Aug 2010 11:12:46 +0200 keltezéssel Israel Saeta Pérez azt írta:

> Hello Benedek,
> 
> On 08/09/2010 03:13 PM, Benedek Zoltan wrote:
>> Hi,
>>
>> I am a beginner in Plone and I can't express my gratitude for such a
>> great open source software. I installed it with the unified installer
>> and I want to master the installation with buildout. I was a sysadmin
>> mainly on closed source software and I want to change to work with open
>> source software. I installed already Linux several times and worked on
>> it, but I see still as a long journey in order to be able to work as a
>> professional in the open source world. I have to understand a lot about
>> Plone as well, I've read a lot about it and I would like to help, at
>> first in the documentation and testing.

Would you be perhaps interested in helping with the Hungarian language 
translations? They would deserve some love. And it's also a good way to 
learn more about Plone.

Best wishes,

-- 
Balazs Ree                 Greenfinity, LLC.
Python, Zope, Plone        http://greenfinity.hu

Re: [Plone-docs] proof-reading user manual

[Israel S. P. <duk...@gm...>]

Hello Benedek,

On 08/09/2010 03:13 PM, Benedek Zoltan wrote:
> Hi,
>
> I am a beginner in Plone and I can't express my gratitude for such a
> great open source software. I installed it with the unified installer
> and I want to master the installation with buildout. I was a sysadmin
> mainly on closed source software and I want to change to work with open
> source software. I installed already Linux several times and worked on
> it, but I see still as a long journey in order to be able to work as a
> professional in the open source world. I have to understand a lot about
> Plone as well, I've read a lot about it and I would like to help, at
> first in the documentation and testing. So I began to proof r ead the
> Plone 4 User Manual according to ticket #10498 from Plone Tune-Up
> Network. What can I do if I've found an inconsistency in the text?
> For example:
> on page: "Conceptual Overview", "What Goes on Behind the Scenes"
> subsection there is: "For example, imagine your butterfly Plone web site
> is located at at mysite.com." (I'm not native English speaker but I
> think the double "at at" sounds not well.)
> on page: " Plone User Accounts and Roles", "Manager" subsection there is:
> "After logging in, if you go to a folder where you have rights, you'll
> see a header strip that has a green color with tabs for /contents/,
> /view/,&nbs p;/edit/,/properties/, and /sharing/:"
> On the screenshot is: Contents, View, Edit, Rules, Sharing

Sorry for the late reply.

I've just fixed the two inconsistencies you mentioned. Thank you for 
reporting!

A good place to report the inconsistencies found in the Plone 4 User 
Manual is the comments of the #10498 ticket itself. If you find other 
mistakes/inconsistencies/etc in the documentation, please use 
https://dev.plone.org/plone/newticket?component=Documentation

Thanks,
-- israel

[Plone-docs] proof-reading user manual

[Benedek Z. <ben...@ya...>]

Hi,

I am a beginner in Plone and I can't express my gratitude for such a great open 
source software. I installed it with the unified installer and I want to master 
the installation with buildout. I was a sysadmin mainly on closed source 
software and I want to change to work with open source software. I installed 
already Linux several times and worked on it, but I see still as a long journey 
in order to be able to work as a professional in the open source world. I have 
to understand a lot about Plone as well, I've read a lot about it and I would 
like to help, at first in the documentation and testing. So I began to proof 
read the Plone 4 User Manual according to ticket #10498 from Plone Tune-Up 
Network. What can I do if I've found an inconsistency in the text?
For example:
on page: "Conceptual Overview", "What Goes on Behind the Scenes" subsection 
there is: "For example, imagine your butterfly Plone web site is located at at 
mysite.com." (I'm not native English speaker but I think the double "at at" 
sounds not well.) 

on page: "Plone User Accounts and Roles", "Manager" subsection there is:
"After logging in, if you go to a folder where you have rights, you'll see a 
header strip that has a green color with tabs 
for contents, view, edit,properties, and sharing:"
On the screenshot is: Contents, View, Edit, Rules, Sharing

Regards,
Zoli



      

Re: [Plone-docs] Collective developer manul update

[Israel S. P. <duk...@gm...>]

On 07/24/2010 02:45 AM, Alex Clark wrote:
> Hi Israel,
>
>
> On 7/18/10 3:35 AM, in article i1uasd$evs$1...@do..., "Israel Saeta
> Pérez"<duk...@gm...>  wrote:
>> Alex Clark know about this, so I hope he will merge this in the next
>> plone.org upgrade (possibly after switching to Plone 4).
>
> Actually can you merge that down to trunk please? With RC1 around the corner
> I expect to be shamed in to make some PloneOrg progress Real Soon Now
>
> IOW, I'm not really planning any more 3.3.5 updates and PloneOrg trunk is
> for Plone 4.


Uhm, looks like I had already done the merge, but I didn't remember :P
http://dev.plone.org/plone/changeset/37457

-- israel

Re: [Plone-docs] Collective developer manul update

[Alex C. <ac...@ac...>]

Hi Israel,


On 7/18/10 3:35 AM, in article i1uasd$evs$1...@do..., "Israel Saeta
Pérez" <duk...@gm...> wrote:

> Hi Mikko,
> 
> On 07/17/2010 08:25 PM, Mikko Ohtamaa wrote:
>> 
>> Hi,
>> 
>> Here is the status update for collective development documentation
>> 
>> - New content update to plone.org was performed today
>> http://plone.org/documentation/manual/plone-community-developer-documentation
>> 
>> - All Sphinx errors and warnings have been fixed in the source
>> 
>> - The manual went through of quick inspection and I merged / fixed some
>> documents
>> 
>> - Descriptions are now correctly place on the pages (if available)
> 
> 
> All this is awesome! Should we/I post a message to the plone mailing
> lists to encourage people to contribute to this manual whenever they can?
> 
>> - There is open issue with plone.org and code example
>> http://www.coactivate.org/projects/deliverance/lists/deliverance-discussion/a
>> rchive/2010/07/1279390563961/forum_view
>> 
>> - New Sphinx CSS should be updated to plone.org (curretly done
>> through-the-web in Zope)
>> https://svn.plone.org/svn/collective/collective.developermanual/trunk/sphinx.
>> css
>> I don't have rights.
> 
> I created a PloneOrg branch and placed the sphinx.css file there:
> http://svn.plone.org/svn/plone/Products.PloneOrg/branches/dukebody-sphinx-inte
> gration/Products/PloneOrg/skins/ploneorg/sphinx.css
> 
> Alex Clark know about this, so I hope he will merge this in the next
> plone.org upgrade (possibly after switching to Plone 4).

Actually can you merge that down to trunk please? With RC1 around the corner
I expect to be shamed in to make some PloneOrg progress Real Soon Now

IOW, I'm not really planning any more 3.3.5 updates and PloneOrg trunk is
for Plone 4.


Alex


> 
>> - Issue with .html extension in URI has been resolved
>> 
>> After the XDV /<pre>  formatting issue has been solved I suggest you will
>> set RedirectRule to all places where the developer manual documentation has
>> been lying around ( collective-docs.plone.org )
> 
> You can ask/bug Laurence Rowe directly about it. :)
> 
> -- israel
> 
> 
> ------------------------------------------------------------------------------
> This SF.net email is sponsored by Sprint
> What will you do first with EVO, the first 4G phone?
> Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first

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

Re: [Plone-docs] Collective developer manul update

[Mikko O. <mik...@re...>]

Mikko Ohtamaa wrote:
> 
> 
> Israel Saeta Pérez wrote:
>> 
>> You can ask/bug Laurence Rowe directly about it. :)
>> 
> 
> After that I can announce my work here done :)
> 

Premature comment - looks like there is problem with index.html files
uploaded to PloneHelpCenter. They contain broken links (because those links
have .html extension which we are now stripping away).

The solution is not to upload index.html files as PloneHelpCenter does not
need them any case - it builds its own index pages automatically.

But expect people complaining a week or so before we get the problem fixed.

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://plone.293351.n2.nabble.com/Collective-developer-manul-update-tp5306724p5311497.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] Collective developer manul update

[Mikko O. <mik...@re...>]

Israel Saeta Pérez wrote:
> 
> You can ask/bug Laurence Rowe directly about it. :)
> 

Laurence kindly fixed this bug and it is now working.

I had to do minor changes to sphinx.css. The file has been committed to
Products.PloneOrg and waits loading to plone.org.

After that I can announce my work here done :)

-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://plone.293351.n2.nabble.com/Collective-developer-manul-update-tp5306724p5308633.html
Sent from the Documentation Team mailing list archive at Nabble.com.

Re: [Plone-docs] Collective developer manul update

[Israel S. P. <duk...@gm...>]

Hi Mikko,

On 07/17/2010 08:25 PM, Mikko Ohtamaa wrote:
>
> Hi,
>
> Here is the status update for collective development documentation
>
> - New content update to plone.org was performed today
> http://plone.org/documentation/manual/plone-community-developer-documentation
>
> - All Sphinx errors and warnings have been fixed in the source
>
> - The manual went through of quick inspection and I merged / fixed some
> documents
>
> - Descriptions are now correctly place on the pages (if available)


All this is awesome! Should we/I post a message to the plone mailing 
lists to encourage people to contribute to this manual whenever they can?

> - There is open issue with plone.org and code example
> http://www.coactivate.org/projects/deliverance/lists/deliverance-discussion/archive/2010/07/1279390563961/forum_view
>
> - New Sphinx CSS should be updated to plone.org (curretly done
> through-the-web in Zope)
> https://svn.plone.org/svn/collective/collective.developermanual/trunk/sphinx.css
> I don't have rights.

I created a PloneOrg branch and placed the sphinx.css file there:
http://svn.plone.org/svn/plone/Products.PloneOrg/branches/dukebody-sphinx-integration/Products/PloneOrg/skins/ploneorg/sphinx.css

Alex Clark know about this, so I hope he will merge this in the next 
plone.org upgrade (possibly after switching to Plone 4).

> - Issue with .html extension in URI has been resolved
>
> After the XDV /<pre>  formatting issue has been solved I suggest you will
> set RedirectRule to all places where the developer manual documentation has
> been lying around ( collective-docs.plone.org )

You can ask/bug Laurence Rowe directly about it. :)

-- israel

[Plone-docs] Collective developer manul update

[Mikko O. <mik...@re...>]

Hi,

Here is the status update for collective development documentation

- New content update to plone.org was performed today
http://plone.org/documentation/manual/plone-community-developer-documentation

- All Sphinx errors and warnings have been fixed in the source 

- The manual went through of quick inspection and I merged / fixed some
documents

- Descriptions are now correctly place on the pages (if available)

- There is open issue with plone.org and code example
http://www.coactivate.org/projects/deliverance/lists/deliverance-discussion/archive/2010/07/1279390563961/forum_view

- New Sphinx CSS should be updated to plone.org (curretly done
through-the-web in Zope)
https://svn.plone.org/svn/collective/collective.developermanual/trunk/sphinx.css
I don't have rights.

- Issue with .html extension in URI has been resolved

After the XDV / <pre> formatting issue has been solved I suggest you will
set RedirectRule to all places where the developer manual documentation has
been lying around ( collective-docs.plone.org )




-----
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://plone.293351.n2.nabble.com/Collective-developer-manul-update-tp5306724p5306724.html
Sent from the Documentation Team mailing list archive at Nabble.com.

[Plone-docs] Fwd: Documentation for ZopeSkel Efforts

[Elizabeth L. <el...@um...>]

Hey Israel -

This was part of my dilema - zopeskel does include other packages but almost
every modern plone tutorial references it. (It's just about impossible to
do efficient plone development without it. +1 Alex)

The hard part about the readme thing is that each zopeskel package has it's
own README. There are 15ish packages in there - thats a lot of README's and
what I'm sure would result in a lot of confusion.

I like Dylan's idea to link to the README's of those packages that a
relevant to Plone. That woud allow some context around zopeskel as it
relates to plone and still allow each package maintainer to keep their stuff
up to date.

Thanks!

Liz

Hey Alex,
>
> On 07/05/2010 02:46 AM, Alex Clark wrote:
> > Hi,
> >
> >
> > On 7/4/10 7:02 AM, in article i0ppod$ub1$1...@do..., "Israel
> Saeta
> > Pérez"<duk...@gm...>  wrote:
> >
> >> On 06/28/2010 09:19 PM, Elizabeth Leddy wrote:
> >>> Hi all -
> >>>
> >>> I want to add some official documentation for zopeskel - where is the
> >>> best place to do that? I know collective docs is the new hotness but
> I'm
> >>> not sure who/what/how on updating that. The zopeskel stuff has several
> >>> contributors so letting everyone have access would be ideal.
> >>
> >> Hey Elizabeth,
> >>
> >> sorry for so late reply - my university network filters the NNTP port.
> :(
> >>
> >> Being ZopeSkel a separated well-delimited package, I'd put its
> >> documentation either inside the proper package README.txt file,
> >> http://svn.plone.org/svn/collective/ZopeSkel/trunk/README.txt
> >
> > Or?
>
> Sorry. I was going to write "or any other txt file inside the package",
> but I wasn't sure if it was going to be shown in the pipy page, and the
> README.txt file is still short enough, so I skipped that.
>
> >>
> >>
> >> This would make the documentation available directly in the PyPI page.
> >
> > You can also host documentation on PyPI by uploading a zip file that has
> a
> > top level index.html (e.g. Sphinx docs), but I have a feeling eleddy is
> > looking for a more "central" place to host the ZopeSkel docsŠ
>
> More central for the documentation of a package than the package itself?
> One cool thing would be to be able to generate pretty, browseable
> documentation pages from the packages' README files, a là
> http://packages.python.org/z3c.form/
>
> > In fact, this reminds me of one of my yet-to-be-proposed-proposals I am
> > considering for 4.1: Include ZopeSkel in Plone core.
>
> But doesn't ZopeSkel include other templates not related to Plone (e.g.
> Silva, nested_namespace, recipe)?
>
> -- israel
>
>
>
> ------------------------------------------------------------------------------
> This SF.net email is sponsored by Sprint
> What will you do first with EVO, the first 4G phone?
> Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs
>

Re: [Plone-docs] Documentation for ZopeSkel Efforts

[Israel S. P. <duk...@gm...>]

Hey Elizabeh,

2010/7/5 Elizabeth Leddy <eli...@gm...>

> Hey Israel -
>
> This was part of my dilema - zopeskel does include other packages but
> almost every modern plone tutorial references it. (It's just about
> impossible to do efficient plone development without it. +1 Alex)
>
> The hard part about the readme thing is that each zopeskel package has it's
> own README. There are 15ish packages in there - thats a lot of README's and
> what I'm sure would result in a lot of confusion.
>
>
I mean http://svn.plone.org/svn/collective/ZopeSkel/trunk/README.txt

You can chain all the relevant README files in one for the long description
in PyPI like in:
http://svn.zope.org/z3c.form/trunk/setup.py?rev=114050&view=markup

-- israel

Re: [Plone-docs] updated collective.developermanual: Generic Setup upgrade steps

[Dylan J. <dy...@dy...>]

cheers.

On 06/07/2010, at 12:53 AM, Israel Saeta Pérez wrote:

> I'd check the ones coming from:
> https://dev.plone.org/collective/log/collective.developermanual/trunk
>
> -- israel
>
>
> 2010/7/5 Dylan Jay <dy...@dy...>
> Anyone know where to get a rss feed for svn commits to the
> collective.developermanual?
>
> Dylan Jay
> Technical solution manager
> PretaWeb 99552830
>
> On 04/07/2010, at 9:08 PM, Israel Saeta Pérez <duk...@gm...>  
> wrote:
>
> > On 07/01/2010 02:30 PM, Kees Hink wrote:
> >> Dear plone-docs list,
> >>
> >> I've written a bit about installing an upgrade step in the  
> developermanual. The
> >> changeset is
> >> https://dev.plone.org/collective/changeset/120050/collective.developermanual/trunk/source
> >>
> >>
> >> This is largely based on Maurits van Rees' blog post at
> >> http://maurits.vanrees.org/weblog/archive/2009/12/catalog. (The  
> manual itself
> >> does not seem like the right place to give credit.)
> >>
> >> Is there anyone systematically reviewing all new contributions?  
> If not: if
> >> someone would care to review, that would be great!
> >
> >
> > Hi Kees,
> >
> > I don't think anyone (expect, perhaps, Mikko?) is systematically
> > reviewing contributions to the collective developer docs. Due to the
> > nature of this manual, anyone can contribute to it without  
> following a
> > reviewing process to ensure accuracy and all.
> >
> > Anyway, if you want someone to review it, I'd ask Maurits  
> directly, or
> > any other who has written upgrade steps for Plone (davisagly,  
> esteele?).
> >
> > Thanks for contributing!
> > -- israel
> >
> >
> >  
> ------------------------------------------------------------------------------
> > This SF.net email is sponsored by Sprint
> > What will you do first with EVO, the first 4G phone?
> > Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first
> > _______________________________________________
> > Plone-docs mailing list
> > Plo...@li...
> > https://lists.sourceforge.net/lists/listinfo/plone-docs
>

Re: [Plone-docs] Documentation for ZopeSkel Efforts

[Dylan J. <dy...@dy...>]

On 05/07/2010, at 10:46 AM, Alex Clark wrote:

> Hi,
>
>
> On 7/4/10 7:02 AM, in article i0ppod$ub1$1...@do..., "Israel  
> Saeta
> Pérez" <duk...@gm...> wrote:
>
>> On 06/28/2010 09:19 PM, Elizabeth Leddy wrote:
>>> Hi all -
>>>
>>> I want to add some official documentation for zopeskel - where is  
>>> the
>>> best place to do that? I know collective docs is the new hotness  
>>> but I'm
>>> not sure who/what/how on updating that. The zopeskel stuff has  
>>> several
>>> contributors so letting everyone have access would be ideal.
>>
>> Hey Elizabeth,
>>
>> sorry for so late reply - my university network filters the NNTP  
>> port. :(
>>
>> Being ZopeSkel a separated well-delimited package, I'd put its
>> documentation either inside the proper package README.txt file,
>> http://svn.plone.org/svn/collective/ZopeSkel/trunk/README.txt
>
> Or?

And you can also link that same README.txt into the  
collective.developermanual as a subsection or appendix. This can be  
achieved by a sphinx extension written by Rok Garbas http://pypi.python.org/pypi/collective.sphinx.includedoc

Re: [Plone-docs] updated collective.developermanual: Generic Setup upgrade steps

[Dylan J. <dy...@dy...>]

Anyone know where to get a rss feed for svn commits to the
collective.developermanual?

Dylan Jay
Technical solution manager
PretaWeb 99552830

On 04/07/2010, at 9:08 PM, Israel Saeta Pérez <duk...@gm...> wrote:

> On 07/01/2010 02:30 PM, Kees Hink wrote:
>> Dear plone-docs list,
>>
>> I've written a bit about installing an upgrade step in the developermanual. The
>> changeset is
>> https://dev.plone.org/collective/changeset/120050/collective.developermanual/trunk/source
>>
>>
>> This is largely based on Maurits van Rees' blog post at
>> http://maurits.vanrees.org/weblog/archive/2009/12/catalog. (The manual itself
>> does not seem like the right place to give credit.)
>>
>> Is there anyone systematically reviewing all new contributions? If not: if
>> someone would care to review, that would be great!
>
>
> Hi Kees,
>
> I don't think anyone (expect, perhaps, Mikko?) is systematically
> reviewing contributions to the collective developer docs. Due to the
> nature of this manual, anyone can contribute to it without following a
> reviewing process to ensure accuracy and all.
>
> Anyway, if you want someone to review it, I'd ask Maurits directly, or
> any other who has written upgrade steps for Plone (davisagly, esteele?).
>
> Thanks for contributing!
> -- israel
>
>
> ------------------------------------------------------------------------------
> This SF.net email is sponsored by Sprint
> What will you do first with EVO, the first 4G phone?
> Visit sprint.com/first -- http://p.sf.net/sfu/sprint-com-first
> _______________________________________________
> Plone-docs mailing list
> Plo...@li...
> https://lists.sourceforge.net/lists/listinfo/plone-docs

Re: [Plone-docs] Documentation for ZopeSkel Efforts

[Israel S. P. <duk...@gm...>]

Hey Alex,

On 07/05/2010 02:46 AM, Alex Clark wrote:
> Hi,
>
>
> On 7/4/10 7:02 AM, in article i0ppod$ub1$1...@do..., "Israel Saeta
> Pérez"<duk...@gm...>  wrote:
>
>> On 06/28/2010 09:19 PM, Elizabeth Leddy wrote:
>>> Hi all -
>>>
>>> I want to add some official documentation for zopeskel - where is the
>>> best place to do that? I know collective docs is the new hotness but I'm
>>> not sure who/what/how on updating that. The zopeskel stuff has several
>>> contributors so letting everyone have access would be ideal.
>>
>> Hey Elizabeth,
>>
>> sorry for so late reply - my university network filters the NNTP port. :(
>>
>> Being ZopeSkel a separated well-delimited package, I'd put its
>> documentation either inside the proper package README.txt file,
>> http://svn.plone.org/svn/collective/ZopeSkel/trunk/README.txt
>
> Or?

Sorry. I was going to write "or any other txt file inside the package", 
but I wasn't sure if it was going to be shown in the pipy page, and the 
README.txt file is still short enough, so I skipped that.

>>
>>
>> This would make the documentation available directly in the PyPI page.
>
> You can also host documentation on PyPI by uploading a zip file that has a
> top level index.html (e.g. Sphinx docs), but I have a feeling eleddy is
> looking for a more "central" place to host the ZopeSkel docsŠ

More central for the documentation of a package than the package itself? 
One cool thing would be to be able to generate pretty, browseable 
documentation pages from the packages' README files, a là
http://packages.python.org/z3c.form/

> In fact, this reminds me of one of my yet-to-be-proposed-proposals I am
> considering for 4.1: Include ZopeSkel in Plone core.

But doesn't ZopeSkel include other templates not related to Plone (e.g. 
Silva, nested_namespace, recipe)?

-- israel