[Catalyst-commits] r12304 - trunk/examples/CatalystAdvent/root/2009/pen

[hbrandenburg at dev.catalyst.perl.org]

Author: hbrandenburg
Date: 2009-12-10 17:37:35 +0000 (Thu, 10 Dec 2009)
New Revision: 12304

Modified:
   trunk/examples/CatalystAdvent/root/2009/pen/configuration-layouts.pod
Log:
style edits

Modified: trunk/examples/CatalystAdvent/root/2009/pen/configuration-layouts.pod
===================================================================
--- trunk/examples/CatalystAdvent/root/2009/pen/configuration-layouts.pod	2009-12-10 17:25:51 UTC (rev 12303)
+++ trunk/examples/CatalystAdvent/root/2009/pen/configuration-layouts.pod	2009-12-10 17:37:35 UTC (rev 12304)
@@ -1,16 +1,16 @@
 =head1 Configuration layouts
 
-One of most common use cases is the need to parametrize an
-application's config in a way it includes your credentials and/or the
-environment's data (for example: db host/port, use of frontend proxy
-or not, caching, require-ssl, etc). It is simple to achieve until your
-project starts to getting bigger.
+A common use case is the need to parametrize an application's config
+in a way that includes your credentials and the environment's data
+(for example: db host/port, use of frontend proxy or not, caching,
+require-ssl, etc). This is simple to achieve until your project starts
+getting bigger.
 
 =head2 Catalyst::Plugin::ConfigLoader
 
 The ConfigLoader plugin gives you the chance to load the config by
-using its suffix approach which will look for a local config file if
-you specify it in the following order of preference:
+using its suffix. This approach which will look for a local config
+file, if specified, in the following order of preference:
 
 =over
 
@@ -23,12 +23,12 @@
 =back
 
 By default the suffix value is C<local>, which will load
-C<myapp_local.conf>, but if for example C<$ENV{
+C<myapp_local.conf>. If, for example, C<$ENV{
 MYAPP_CONFIG_LOCAL_SUFFIX }> is set to C<testing>, ConfigLoader will
-try and load C<myapp_testing.conf> instead of C<myapp_local.conf>.
+try to load C<myapp_testing.conf> instead of C<myapp_local.conf>.
 
 Or you could even load local files for each config set directly from
-your main file like:
+your main file:
 
     # load db config file, in Config::General format
     <Model::Database>
@@ -38,18 +38,19 @@
         </connect_info>
     </Model::Database>
 
-Both of these approaches gets in your way when you have X number of
-applications with Y number of developers and Z number of boxes foreach
-environment (devel, testing, staging and production) to manage.
+Both of these approaches get in your way when you have X number of
+applications with Y number of developers and Z number of boxes for
+each environment (development, testing, staging and production).
 
 =head2 MyCompany::Plugin::ConfigLoader
 
-So, all you just need to do is extend the C<get_config_local_suffix>
-method from ConfigLoad plugin and implement your own logic of loading
-config files to fit in your requirements.
+So, all you need to do is extend the C<get_config_local_suffix> method
+from ConfigLoad plugin and implement your own config file loading
+logic.
 
-For example
 
+For example:
+
     package MyCompany::Plugin::ConfigLoader;
 
     use strict;
@@ -72,7 +73,7 @@
 
     1;
 
-thus, in your app class
+Then, in your app class
 
     use Catalyst qw/+MyCompany::Plugin::ConfigLoader/;
 
@@ -80,18 +81,18 @@
 
     __PACKAGE__->config( 'Plugin::ConfigLoader' => { file => __PACKAGE__->path_to('conf') } );
 
-that will load a config file under C<conf> dir in your app's homedir
-based on current sysuser and hostname (e.g. myapp_wreis_hercule.conf),
-and you could even set the C<CONFIG_ENV_SUFFIX> env var, thus it would
-be appended to the config local suffix
-(e.g. myapp_wreis_hercule_staging.conf).
+This loads a config file under C<conf> directory in your application's
+homedir based on current sysuser and hostname
+(e.g. myapp_wreis_hercule.conf).  You can even set the
+C<CONFIG_ENV_SUFFIX> environment variable, and it would be appended to
+the config local suffix (e.g. myapp_wreis_hercule_staging.conf).
 
-Remember that you are still able to load a specific config file at any
-time by setting MYAPP_CONFIG=/path/to/config/file or CATALYST_CONFIG
-env var.
+Remember that you can load a specific config file at any time by
+setting MYAPP_CONFIG=/path/to/config/file or CATALYST_CONFIG
+environment variable.
 
 =head1 SEE ALSO
-
+	
 L<Catalyst Advent Calendar 2007-15|http://www.catalystframework.org/calendar/2007/15>,
 L<Catalyst Advent Calendar 2008-10|http://www.catalystframework.org/calendar/2008/10>, 
 L<Catalyst::Plugin::ConfigLoader::Multi>.