Re: Plone deployment manual

Dylan Jay <dylan-Q+/Sk2sTzaxWk0Htik3J/[email protected]> Wed, 27 Jul 2011 15:11:08 +1000
Newsgroups gmane.comp.web.zope.plone.documentation
Message-ID <[email protected]>
On 27/07/2011, at 2:22 PM, T. Kim Nguyen wrote:

> Hello again - apologies if it seems I am barraging the list.
>
> As part of the monthly PloneEdu calls we've been coming up with  
> ideas on how to build resources for (primarily) educational  
> institutions using Plone.  One of those ideas is to create  
> documentation relating to how educational institutions have deployed  
> Plone: the server environment, cacheing, authentication, load  
> balancing, and so on.
>
> (While PloneEdu's mission is specifically education related, a lot  
> of what we do is of general use to any organization using Plone).
>
> In my completely unscientific method of looking around for "plone  
> deployment manual", "plone deployment guide", "how to deploy Plone",  
> I have found some resources here and there, but nothing pulling it  
> all together in one place, presumably on plone.org/documentation.
>
> Content that would be useful in such a manual:
>
> - the above bits and pieces of a production stack
>
> - sample configurations (buildouts, squid.cfg, pound.cfg,  
> httpd.conf, ssl.conf, etc.)
>
> - case studies of deployments (by "deployment" I refer specifically  
> to the server setup)
>
> - forms for accepting new deployment case studies submitted
>
> Has this already been done?  If not, does this seem like a good  
> idea, and if so, how to proceed?

My opinion (and keep in mind it is just my opinion) is that the place  
for this and all future development manual work should be

http://plone.org/documentation/manual/plone-community-developer-documentation

which is edited via reST and sphinx and github as per these  
instructions http://plone.org/documentation/manual/plone-community-developer-documentation/introduction/writing

NOTE: at the time of writing this that document is out of date and the  
secondary copy at readthedocs is now more up to date.
http://collective-docs.readthedocs.org/en/latest/introduction/writing.html 
. We're working on fixing this so the plone.org version would be  
updated nightly.

My suggestion is we deprecate all other developer manuals and KB  
articles which overlap with the collective developer manual and  
concentrate on cleaning up and making this manual both clean, easy to  
understand and comprehensive.

With regard to deployment I'd suggest we enhance the "hosting" section  
of this manual

http://collective-docs.readthedocs.org/en/latest/hosting/index.html


Note: these comments don't apply to the users manual or other kinds of  
documentation.


>
> 	Kim
>
>
> ------------------------------------------------------------------------------
> Got Input?   Slashdot Needs You.
> Take our quick survey online.  Come on, we don't ask for help often.
> Plus, you'll get a chance to win $100 to spend on ThinkGeek.
> http://p.sf.net/sfu/slashdot-survey
> _______________________________________________
> Plone-docs mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/plone-docs


------------------------------------------------------------------------------
Got Input?   Slashdot Needs You.
Take our quick survey online.  Come on, we don't ask for help often.
Plus, you'll get a chance to win $100 to spend on ThinkGeek.
http://p.sf.net/sfu/slashdot-survey