Document uses of resources directory

nebhale · nebhale · commit 2df371858de1 · 2014-03-28T12:45:27.000Z
Previously there were a number of components that took advantage of
the copy_resources() functionality for configuration.  This facility
is intended to be used by people who fork the buildpack as well, but
wasn't documented anywhere.

This change updates the documentation to indicate where the resources
directory can be used and how to use it.  The documentation also
includes some examples of things you use the resources directory for
(e.g. JCE Unlimited Security).

[#68345350]
diff --git a/docs/container-tomcat.md b/docs/container-tomcat.md
@@ -33,6 +33,9 @@ The container can be configured by modifying the [`config/tomcat.yml`][] file in
 | `redis_store.timeout` | The Redis connection timeout (in milliseconds).
 | `redis_store.connection_pool_size` | The Redis connection pool size.  Note that this is per-instance, not per-application.
 
+### Additional Resources
+The container can also be configured by overlaying a set of resources on the default distribution.  To do this, add files to the `resources/tomcat` directory in the buildpack fork.  For example, to override the default `logging.properties` add your custom file to `resources/tomcat/conf/logging.properties`.
+
 ## Session Replication
 By default, the Tomcat instance is configured to store all Sessions and their data in memory.  Under certain cirmcumstances it my be appropriate to persist the Sessions and their data to a repository.  When this is the case (small amounts of data that should survive the failure of any individual instance), the buildpack can automatically configure Tomcat to do so.
 
diff --git a/docs/framework-app_dynamics_agent.md b/docs/framework-app_dynamics_agent.md
@@ -36,7 +36,6 @@ The framework can be configured by modifying the [`config/app_dynamics_agent.yml
 ### Additional Resources
 The framework can also be configured by overlaying a set of resources on the default distribution.  To do this, add files to the `resources/app_dynamics_agent` directory in the buildpack fork.  For example, to override the default `app-agent-config.xml` add your custom file to `resources/app_dynamics_agent/conf/app-agent-config.xml`.
 
-
 [`config/app_dynamics_agent.yml`]: ../config/app_dynamics_agent.yml
 [AppDynamics Service]: http://www.appdynamics.com
 [Configuration and Extension]: ../README.md#configuration-and-extension
diff --git a/docs/framework-new_relic_agent.md b/docs/framework-new_relic_agent.md
@@ -35,6 +35,9 @@ The framework can be configured by modifying the [`config/new_relic_agent.yml`][
 | `repository_root` | The URL of the New Relic repository index ([details][repositories]).
 | `version` | The version of New Relic to use. Candidate versions can be found in [this listing][].
 
+### Additional Resources
+The framework can also be configured by overlaying a set of resources on the default distribution.  To do this, add files to the `resources/new_relic_agent` directory in the buildpack fork.  For example, to override the default `new_relic.yml` add your custom file to `resources/new_relic_agent/newrelic.yml`.
+
 [Configuration and Extension]: ../README.md#configuration-and-extension
 [`config/new_relic_agent.yml`]: ../config/new_relic_agent.yml
 [New Relic Service]: https://newrelic.com
diff --git a/docs/jre-open_jdk_jre.md b/docs/jre-open_jdk_jre.md
@@ -25,6 +25,9 @@ The JRE can be configured by modifying the [`config/open_jdk_jre.yml`][] file in
 | `memory_sizes` | Optional memory sizes, described below under "Memory Sizes".
 | `memory_heuristics` | Default memory size weightings, described below under "Memory Weightings.
 
+### Additional Resources
+The JRE can also be configured by overlaying a set of resources on the default distribution.  To do this, add files to the `resources/open_jdk_jre` directory in the buildpack fork.  For example, to add the JCE Unlimited Strength `local_policy.jar` add your file to `resources/open_jdk_jre/lib/security/local_policy.jar`.
+
 ### Memory
 The total available memory is specified when an application is pushed as part of it's configuration. The Java buildpack uses this value to control the JRE's use of various regions of memory. The JRE memory settings can be influenced by configuring the `memory_sizes` and/or `memory_heuristics` mappings.
 
diff --git a/docs/jre-oracle_jre.md b/docs/jre-oracle_jre.md
@@ -34,6 +34,9 @@ The JRE can be configured by modifying the [`config/oracle_jre.yml`][] file in t
 | `memory_sizes` | Optional memory sizes, described below under "Memory Sizes".
 | `memory_heuristics` | Default memory size weightings, described below under "Memory Weightings.
 
+### Additional Resources
+The JRE can also be configured by overlaying a set of resources on the default distribution.  To do this, add files to the `resources/oracle_jre` directory in the buildpack fork.  For example, to add the JCE Unlimited Strength `local_policy.jar` add your file to `resources/oracle_jre/lib/security/local_policy.jar`.
+
 ### Memory
 The total available memory is specified when an application is pushed as part of it's configuration. The Java buildpack uses this value to control the JRE's use of various regions of memory. The JRE memory settings can be influenced by configuring the `memory_sizes` and/or `memory_heuristics` mappings.
 
