Link to general configuration

Glyn Normington · Glyn Normington · commit 4a4e2537bfdf · 2013-08-14T11:57:25.000+01:00
Also some frameworks referred to themselves as containers. This is
fixed.

[#54984734]
diff --git a/docs/container-groovy.md b/docs/container-groovy.md
@@ -16,13 +16,16 @@ The Groovy Container allows a uncompiled (i.e. `*.groovy`) to be run.
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The container can be configured by modifying the [`config/groovy.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
 | ---- | -----------
 | `repository_root` | The URL of the Groovy repository index ([details][repositories]).
 | `version` | The version of Groovy to use. Candidate versions can be found in [this listing][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/groovy.yml`]: ../config/groovy.yml
 [repositories]: util-repositories.md
 [this listing]: http://download.pivotal.io.s3.amazonaws.com/groovy/lucid/x86_64/index.yml
diff --git a/docs/container-java-main.md b/docs/container-java-main.md
@@ -16,11 +16,14 @@ Command line arguments may optionally be configured.
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The container can be configured by modifying the [`config/main.yml`][] file.
 
 | Name | Description
 | ---- | -----------
 | `arguments` | Optional command line arguments to be passed to the Java main class. The arguments are specified as a single YAML scalar in plain style or enclosed in single or double quotes.
 | `java_main_class` | The Java class name to run. Values containing whitespace are rejected with an error, but all others values appear without modification on the Java command line.  If not specified, the Java Manifest value of `Main-Class` is used.
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/main.yml`]: ../config/main.yml
diff --git a/docs/container-spring-boot-cli.md b/docs/container-spring-boot-cli.md
@@ -19,13 +19,16 @@ Tags are printed to standard output by the buildpack detect script.
 In order to specify [Spring profiles][], set the [`SPRING_PROFILES_ACTIVE`][] environment variable.  This is automatically detected and used by Spring.
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The container can be configured by modifying the [`config/springbootcli.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
 | ---- | -----------
 | `repository_root` | The URL of the Spring Boot CLI repository index ([details][repositories]).
 | `version` | The version of Spring Boot CLI to use. Candidate versions can be found in [this listing][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/springbootcli.yml`]: ../config/springbootcli.yml
 [repositories]: util-repositories.md
 [Spring profiles]:http://blog.springsource.com/2011/02/14/spring-3-1-m1-introducing-profile/
diff --git a/docs/container-tomcat.md b/docs/container-tomcat.md
@@ -14,6 +14,8 @@ Tags are printed to standard output by the buildpack detect script
 In order to specify [Spring profiles][], set the [`SPRING_PROFILES_ACTIVE`][] environment variable.  This is automatically detected and used by Spring.
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The container can be configured by modifying the [`config/tomcat.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
@@ -24,6 +26,7 @@ The container can be configured by modifying the [`config/tomcat.yml`][] file.
 ## Supporting Functionality
 Additional supporting functionality can be found in the [`java-buildpack-support`][] Git repository.
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/tomcat.yml`]: ../config/tomcat.yml
 [`java-buildpack-support`]: https://github.com/cloudfoundry/java-buildpack-support
 [repositories]: util-repositories.md
diff --git a/docs/framework-java_opts.md b/docs/framework-java_opts.md
@@ -13,10 +13,13 @@ Tags are printed to standard output by the buildpack detect script
 
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The framework can be configured by modifying the [`config/javaopts.yml`][] file.
 
 | Name | Description
 | ---- | -----------
 | `java_opts` | The Java options to use when running the application.  All values are used without modification when invoking the JVM. The options are specified as a single YAML scalar in plain style or enclosed in single or double quotes.
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/javaopts.yml`]: ../config/javaopts.yml
diff --git a/docs/framework-new-relic.md b/docs/framework-new-relic.md
@@ -12,13 +12,16 @@ The New Relic Framework causes an application to be automatically configured to
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
-The container can be configured by modifying the [`config/newrelic.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework can be configured by modifying the [`config/newrelic.yml`][] file.  The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
 | ---- | -----------
 | `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][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/newrelic.yml`]: ../config/newrelic.yml
 [New Relic Service]: https://newrelic.com
 [repositories]: util-repositories.md
diff --git a/docs/framework-play-auto-reconfiguration.md b/docs/framework-play-auto-reconfiguration.md
@@ -12,14 +12,17 @@ The Play Auto Reconfiguration Framework causes an application to be automaticall
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
-The container can be configured by modifying the [`config/playautoreconfiguration.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework can be configured by modifying the [`config/playautoreconfiguration.yml`][] file.  The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 
 | Name | Description
 | ---- | -----------
 | `repository_root` | The URL of the Auto Reconfiguration repository index ([details][repositories]).
 | `version` | The version of Auto Reconfiguration to use. Candidate versions can be found in [this listing][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/playautoreconfiguration.yml`]: ../config/playautoreconfiguration.yml
 [repositories]: util-repositories.md
 [this listing]: http://download.pivotal.io.s3.amazonaws.com/auto-reconfiguration/lucid/x86_64/index.yml
diff --git a/docs/framework-play-jpa-plugin.md b/docs/framework-play-jpa-plugin.md
@@ -18,13 +18,16 @@ The Play JPA Plugin Framework causes an application to be automatically reconfig
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
-The container can be configured by modifying the [`config/playjpaplugin.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework can be configured by modifying the [`config/playjpaplugin.yml`][] file.  The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
 | ---- | -----------
 | `repository_root` | The URL of the Play JPA Plugin repository index ([details][repositories]).
 | `version` | The version of the Play JPA Plugin to use. Candidate versions can be found in [this listing][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/playjpaplugin.yml`]: ../config/playjpaplugin.yml
 [repositories]: util-repositories.md
 [this listing]: http://download.pivotal.io.s3.amazonaws.com/play-jpa-plugin/lucid/x86_64/index.yml
diff --git a/docs/framework-spring-auto-reconfiguration.md b/docs/framework-spring-auto-reconfiguration.md
@@ -17,13 +17,16 @@ If a `/WEB-INF/web.xml` file exists, the framework will modify it in addition to
 2. Augmenting `contextInitializerClasses`.  The function starts by enumerating the current `contextInitializerClasses`.  If none exist, a default configuration is created with no value as the default. The `org.cloudfoundry.reconfiguration.spring.CloudApplicationContextInitializer` class is then added to the collection of classes.
 
 ## Configuration
-The container can be configured by modifying the [`config/springautoreconfiguration.yml`][] file.  The container uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
+The framework can be configured by modifying the [`config/springautoreconfiguration.yml`][] file.  The framework uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
 
 | Name | Description
 | ---- | -----------
 | `repository_root` | The URL of the Auto Reconfiguration repository index ([details][repositories]).
 | `version` | The version of Auto Reconfiguration to use. Candidate versions can be found in [this listing][].
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/springautoreconfiguration.yml`]: ../config/springautoreconfiguration.yml
 [repositories]: util-repositories.md
 [this listing]: http://download.pivotal.io.s3.amazonaws.com/auto-reconfiguration/lucid/x86_64/index.yml
diff --git a/docs/jre-openjdk.md b/docs/jre-openjdk.md
@@ -12,6 +12,8 @@ The OpenJDK JRE provides Java runtimes from the [OpenJDK][] project.  Versions o
 Tags are printed to standard output by the buildpack detect script
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The JRE can be configured by modifying the [`config/openjdk.yml`][] file.  The JRE uses the [`Repository` utility support][repositories] and so it supports the [version syntax][]  defined there.
 
 | Name | Description
@@ -40,6 +42,7 @@ If a memory size is specified which is not equal to the default value, the other
 
 The default memory size proportions are configured in the `memory_heuristics` mapping of [`config/openjdk.yml`][]. Each memory size is given a weighting between `0` and `1` corresponding to a proportion of the total memory specified when the application was pushed. The weightings should add up to `1`.
 
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
 [`config/openjdk.yml`]: ../config/openjdk.yml
 [OpenJDK]: http://openjdk.java.net
 [repositories]: util-repositories.md
diff --git a/docs/logging.md b/docs/logging.md
@@ -23,6 +23,8 @@ both parameter and block forms:
     logger.debug { "#{costly_method}" }
 
 ## Configuration
+For general information on configuring the buildpack, refer to [Configuration and Extension][].
+
 The log level is configured by setting an environment variable
 `$JBP_LOG_LEVEL` to one of:
 
@@ -39,4 +41,6 @@ The logging levels in `JBP_LOG_LEVEL` and `config/logging.yml` may be
 specified using any mixture of upper and lower case.
 
 Ruby's verbose and debug modes override the default log level to `DEBUG` unless
-`JBP_LOG_LEVEL` has been set, in which case this takes priority.
+`JBP_LOG_LEVEL` has been set, in which case this takes priority.
+
+[Configuration and Extension]: ../README.md#Configuration-and-Extension
