[Catalyst-dev] Documentation/Wiki

Wed Jun 4 06:52:46 GMT 2014

Hi John,

I think the areas most lacking are setting up a good development 
environment where nothing really needs to be changed besides 
apache/nginx configuration to move onto production. There is some 
documentation out there, but I found it to be a bit incomplete for my 
needs, and there were a few important points where for whatever reason 
what was written just didn't work. I thought most other things were easy 
enough to find just from what was out there in the wild ;) . For the 
development environment I mostly wound up taking things from what people 
wrote for other frameworks like ruby on rails.

I also think there could be some more best practice methods when having 
several applications on a single server. Things like changing your 
skeleton from MyApp/root/{src,static} to MyApp/root/myapp/{src,static} 
so your paths can be aliased as /myapp1/static, /myapp2/static, so on 
and so forth. I also moved quite a bit out from the catalyst skeleton to 
my own perl modules, which maybe goes a bit more in a general perl and 
building models kind of thing, but it bears mentioning.

(This is long, but I don't know how to explain it except with an example).

There's also keeping your config files insync.

For instance in my skeleton I have

MyApp/{catalyst stuff}
MyApp/bin - for my custom executable scripts
MyApp/conf - for my config files

MyApp/conf/catalyst - for catalyst config files
MyApp/conf/nginx - for nginx files
MyApp/conf/nginx/myapp.nginx.dev.conf - nginx dev file using the build 
in catalyst server and proxy pass
MyApp/conf/nginx/myapp.nginx.prod.conf - nginx production file using fastcgi
MyApp/conf/tmuxifier - to handle my tmux sessions

Then I have a inotifier-hookable (its a perl module) script that watches 
those files for changes and syncs them over to the approapriate 
location. That way I have all my application specific files under one 
git repo, and that makes me happy, and the files go to their appropriate 
locations, which makes nginx/apache/tmuxifier happy.

Best,
Jillian

On 06/02/2014 05:56 PM, John Napiorkowski wrote:
> Jillian,
>
> Well there's always a ton to document :)  The documentation project I 
> recently started is somewhat narrowly scoped to provide more details 
> and explanation of the whys and hows of Catalyst so that intermediate 
> level programmers can move to a higher level.  Also, the idea here is 
> that these docs will provide a good compare and contrast point for 
> what Catalyst 6 might be like.  So those are the goals.  The first 
> step is to firm out the initial outline, so I'd love to get PR on 
> topics that fit into the existing categories:
>
> https://github.com/perl-catalyst/Catalyst-Components-Concepts-Cases
> Then we can start writing the actual docs.
>
> Thanks!  john
>
>
> On Monday, June 2, 2014 9:34 AM, Jillian Rowe 
> <jir2004 at qatar-med.cornell.edu> wrote:
>
>
> Hi John,
>
> Went on leave for a few days and came back to excitement. ;-)
>
> I'd love to collaborate. Anything from the github gists is free game, 
> and I have a few other things I've been meaning to write up. I think 
> it would be a good idea to have things that I've figured out from the 
> mailing list or stack overflow. Stuff like shared authentication, 
> having your model in a model outside of your catalyst skeleton, 
> somethings I've done recently to tighten up config files. I did a lot 
> of work earlier this year to integrate my development and production 
> environments. I have quite a bit on combining dojo/javascript within 
> the skeleton and getting best use out of dijit/dojo with 
> HTML::FormHandler.
>
> If there's an area you think could use some particular attention and I 
> already have something written for it let me know, otherwise I intend 
> on doing a lot of documentation in the upcoming weeks as I finish up a 
> (catalyst based) project.
>
> Best,
> Jillian
>
> On 05/29/2014 05:59 PM, John Napiorkowski wrote:
> FWIW I started a new 'intermediate level' documentation project and 
> I'd love to get collaboration:
>
> The writeup is here: 
> http://jjnapiorkowski.typepad.com/modern-perl/2014/05/perl-catalyst-concepts-components-and-use-cases.htm
>
>
>
> On Tuesday, May 27, 2014 3:15 PM, Ali M. <tclwarrior at gmail.com> 
> <mailto:tclwarrior at gmail.com> wrote:
>
>
> well,
>
> you can always write those as a series of blog posts, and subscribe to 
> planet ironman perl http://ironman.enlightenedperl.org/new_feed
> perl can always use more bloggers
>
> Regards,
> Ali
>
>
> On Tue, May 20, 2014 at 4:01 PM, Jillian Rowe 
> <jir2004 at qatar-med.cornell.edu <mailto:jir2004 at qatar-med.cornell.edu>> 
> wrote:
>
>     Hello,
>
>     I would like to add to the Catalyst wiki, but I'm not sure
>     where/how. It seems as if most of the items in the wiki are older.
>     I'm not sure if this is because Catalyst is running the world ;)
>     or because its moved.
>
>     I'm not sure most of things I've written belong in the core
>     documentation, mostly they are related items and best practices
>     (imo) such as getting catalyst going with perlbrew, nginx and
>     apache configs with fastcgi/built in server, my awesome
>     development environment and various decisions we've made to stream
>     line the process from development to production.
>
>     https://gist.github.com/jerowe
>
>     Best,
>     Jillian
>
>
>
>     _______________________________________________
>     Catalyst-dev mailing list
>     Catalyst-dev at lists.scsys.co.uk <mailto:Catalyst-dev at lists.scsys.co.uk>
>     http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
>
>
>
> _______________________________________________
> Catalyst-dev mailing list
> Catalyst-dev at lists.scsys.co.uk <mailto:Catalyst-dev at lists.scsys.co.uk>
> http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
>
>
>
>
> _______________________________________________
> Catalyst-dev mailing list
> Catalyst-dev at lists.scsys.co.uk  <mailto:Catalyst-dev at lists.scsys.co.uk>
> http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
>
>
> _______________________________________________
> Catalyst-dev mailing list
> Catalyst-dev at lists.scsys.co.uk <mailto:Catalyst-dev at lists.scsys.co.uk>
> http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev
>
>
>
>
> _______________________________________________
> Catalyst-dev mailing list
> Catalyst-dev at lists.scsys.co.uk
> http://lists.scsys.co.uk/cgi-bin/mailman/listinfo/catalyst-dev

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.scsys.co.uk/pipermail/catalyst-dev/attachments/20140604/b5df8f36/attachment-0001.htm>