From ecafd7f0757bff44e693cdc2a83c1bee2f642c3b Mon Sep 17 00:00:00 2001
From: Ryan Baxter <rbaxter@pivotal.io>
Date: Mon, 16 Sep 2019 16:11:55 -0400
Subject: [PATCH] Added generated config properties docs.  Fixes #61

---
 docs/pom.xml                                  | 27 +++++++++++++++++++
 docs/src/main/asciidoc/_attributes.adoc       | 15 +++++++++++
 docs/src/main/asciidoc/_configprops.adoc      | 18 +++++++++++++
 docs/src/main/asciidoc/appendix.adoc          | 14 ++++++++++
 .../asciidoc/spring-cloud-cloudfoundry.adoc   |  6 ++++-
 5 files changed, 79 insertions(+), 1 deletion(-)
 create mode 100644 docs/src/main/asciidoc/_attributes.adoc
 create mode 100644 docs/src/main/asciidoc/_configprops.adoc
 create mode 100644 docs/src/main/asciidoc/appendix.adoc

diff --git a/docs/pom.xml b/docs/pom.xml
index 94f5d64..bedfd76 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -16,7 +16,26 @@
 		<docs.main>spring-cloud-cloudfoundry</docs.main>
 		<main.basedir>${basedir}/..</main.basedir>
 		<docs.whitelisted.branches>1.0.x,1.1.x,2.1.x</docs.whitelisted.branches>
+		<configprops.inclusionPattern>spring.cloud.cloudfoundry.*</configprops.inclusionPattern>
 	</properties>
+	<dependencies>
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-cloud-starter-cloudfoundry</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-cloud-cloudfoundry-commons</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-cloud-cloudfoundry-web</artifactId>
+		</dependency>
+		<dependency>
+			<groupId>${project.groupId}</groupId>
+			<artifactId>spring-cloud-cloudfoundry-discovery</artifactId>
+		</dependency>
+	</dependencies>
 	<build>
 		<plugins>
 			<plugin>
@@ -32,6 +51,14 @@
 			<id>docs</id>
 			<build>
 				<plugins>
+					<plugin>
+						<groupId>pl.project13.maven</groupId>
+						<artifactId>git-commit-id-plugin</artifactId>
+					</plugin>
+					<plugin>
+						<groupId>org.codehaus.mojo</groupId>
+						<artifactId>exec-maven-plugin</artifactId>
+					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-dependency-plugin</artifactId>
diff --git a/docs/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc
new file mode 100644
index 0000000..8652664
--- /dev/null
+++ b/docs/src/main/asciidoc/_attributes.adoc
@@ -0,0 +1,15 @@
+:doctype: book
+:idprefix:
+:idseparator: -
+:toc: left
+:toclevels: 4
+:tabsize: 4
+:numbered:
+:sectanchors:
+:sectnums:
+:icons: font
+:hide-uri-scheme:
+:docinfo: shared,private
+
+:sc-ext: java
+:project-full-name: Spring Cloud Cloud Foundry
diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc
new file mode 100644
index 0000000..d3b11db
--- /dev/null
+++ b/docs/src/main/asciidoc/_configprops.adoc
@@ -0,0 +1,18 @@
+|===
+|Name | Default | Description
+
+|spring.cloud.cloudfoundry.discovery.default-server-port | 80 | Port to use when no port is defined by ribbon.
+|spring.cloud.cloudfoundry.discovery.enabled | true | Flag to indicate that discovery is enabled.
+|spring.cloud.cloudfoundry.discovery.heartbeat-frequency | 5000 | Frequency in milliseconds of poll for heart beat. The client will poll on this frequency and broadcast a list of service ids.
+|spring.cloud.cloudfoundry.discovery.internal-domain | apps.internal | Default internal domain when configured to use Native DNS service discovery.
+|spring.cloud.cloudfoundry.discovery.order | 0 | Order of the discovery client used by `CompositeDiscoveryClient` for sorting available clients.
+|spring.cloud.cloudfoundry.discovery.use-container-ip | false | Whether to resolve hostname when BOSH DNS is used. In order to use this feature, spring.cloud.cloudfoundry.discovery.use-dns must be true.
+|spring.cloud.cloudfoundry.discovery.use-dns | false | Whether to use BOSH DNS for the discovery. In order to use this feature, your Cloud Foundry installation must support Service Discovery.
+|spring.cloud.cloudfoundry.org |  | Organization name to initially target.
+|spring.cloud.cloudfoundry.password |  | Password for user to authenticate and obtain token.
+|spring.cloud.cloudfoundry.skip-ssl-validation | false | 
+|spring.cloud.cloudfoundry.space |  | Space name to initially target.
+|spring.cloud.cloudfoundry.url |  | URL of Cloud Foundry API (Cloud Controller).
+|spring.cloud.cloudfoundry.username |  | Username to authenticate (usually an email address).
+
+|===
diff --git a/docs/src/main/asciidoc/appendix.adoc b/docs/src/main/asciidoc/appendix.adoc
new file mode 100644
index 0000000..39eb159
--- /dev/null
+++ b/docs/src/main/asciidoc/appendix.adoc
@@ -0,0 +1,14 @@
+:numbered!:
+[appendix]
+[[common-application-properties]]
+== Common application properties
+
+include::_attributes.adoc[]
+
+Various properties can be specified inside your `application.properties` file, inside your `application.yml` file, or as command line switches.
+This appendix provides a list of common {project-full-name} properties and references to the underlying classes that consume them.
+
+NOTE: Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list.
+Also, you can define your own properties.
+
+include::_configprops.adoc[]
diff --git a/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc b/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc
index 125df81..56f94e9 100644
--- a/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc
+++ b/docs/src/main/asciidoc/spring-cloud-cloudfoundry.adoc
@@ -1,5 +1,5 @@
 = Spring Cloud for Cloud Foundry
-:nofooter:
+include::_attributes.adoc[]
 
 include::intro.adoc[]
 
@@ -28,3 +28,7 @@ service called "sso", for instance, with credentials containing
 automatically to the Spring OAuth2 client that you enable with
 `@EnableOAuth2Sso` (from Spring Boot). The name of the service can be
 parameterized using `spring.oauth2.sso.serviceId`.
+
+== Configuration
+
+To see the list of all Sleuth related configuration properties please check link:appendix.html[the Appendix page].