Build Antora docs.

.gitignore

@@ -21,3 +21,9 @@ _site/
 .vscode/
 .flattened-pom.xml
 
+
+node
+node_modules
+build
+package.json
+package-lock.json

docs/antora-playbook.yml

@@ -6,15 +6,10 @@ antora:
     - '@antora/collector-extension'
     - '@antora/atlas-extension'
     - require: '@springio/antora-extensions/root-component-extension'
-      root_component_name: 'PROJECT_WITHOUT_SPRING'
+      root_component_name: 'cloud-openfeign'
-      # FIXME: Run antora once using this extension to migrate to the Asciidoc Tabs syntax
-      # and then remove this extension
-    - require: '@springio/antora-extensions/tabs-migration-extension'
-      unwrap_example_block: always
-      save_result: true
 site:
-  title: PROJECT_FULL_NAME
+  title: Spring Cloud Openfeign
-  url: https://docs.spring.io/PROJECT_NAME/reference/
+  url: https://docs.spring.io/spring-cloud-openfeign/reference/
 content:
   sources:
     - url: ./..

docs/antora.yml

@@ -1,6 +1,6 @@
-name: PROJECT_WITHOUT_SPRING
+name: cloud-openfeign
 version: true
-title: PROJECT_NAME
+title: Spring Cloud OpenFeign
 nav:
   - modules/ROOT/nav.adoc
 ext:

docs/modules/ROOT/nav.adoc

@@ -1,9 +1,5 @@
 * xref:index.adoc[]
-* xref:spring-cloud-openfeign.adoc[]
+** xref:intro.adoc[]
-* xref:_attributes.adoc[]
+** xref:spring-cloud-openfeign.adoc[]
-* xref:intro.adoc[]
-* xref:README.adoc[]
-* xref:_configprops.adoc[]
 * xref:appendix.adoc[]
-* xref:sagan-boot.adoc[]
+** xref:configprops.adoc[]
-* xref:sagan-index.adoc[]

docs/modules/ROOT/pages/_configprops.adoc

@@ -1,37 +0,0 @@
-|===
-|Name | Default | Description
-
-|spring.cloud.openfeign.autoconfiguration.jackson.enabled | `false` | If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding.
-|spring.cloud.openfeign.circuitbreaker.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker.
-|spring.cloud.openfeign.circuitbreaker.group.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group.
-|spring.cloud.openfeign.client.config |  | 
-|spring.cloud.openfeign.client.decode-slash | `true` | Feign clients do not encode slash `/` characters by default. To change this behavior, set the `decodeSlash` to `false`.
-|spring.cloud.openfeign.client.default-config | `default` | 
-|spring.cloud.openfeign.client.default-to-properties | `true` | 
-|spring.cloud.openfeign.client.refresh-enabled | `false` | Enables options value refresh capability for Feign.
-|spring.cloud.openfeign.compression.request.enabled | `false` | Enables the request sent by Feign to be compressed.
-|spring.cloud.openfeign.compression.request.mime-types | `[text/xml, application/xml, application/json]` | The list of supported mime types.
-|spring.cloud.openfeign.compression.request.min-request-size | `2048` | The minimum threshold content size.
-|spring.cloud.openfeign.compression.response.enabled | `false` | Enables the response from Feign to be compressed.
-|spring.cloud.openfeign.encoder.charset-from-content-type | `false` | Indicates whether the charset should be derived from the {@code Content-Type} header.
-|spring.cloud.openfeign.httpclient.connection-timeout | `2000` | 
-|spring.cloud.openfeign.httpclient.connection-timer-repeat | `3000` | 
-|spring.cloud.openfeign.httpclient.disable-ssl-validation | `false` | 
-|spring.cloud.openfeign.httpclient.enabled | `true` | Enables the use of the Apache HTTP Client by Feign.
-|spring.cloud.openfeign.httpclient.follow-redirects | `true` | 
-|spring.cloud.openfeign.httpclient.hc5.enabled | `false` | Enables the use of the Apache HTTP Client 5 by Feign.
-|spring.cloud.openfeign.httpclient.hc5.pool-concurrency-policy |  | Pool concurrency policies.
-|spring.cloud.openfeign.httpclient.hc5.pool-reuse-policy |  | Pool connection re-use policies.
-|spring.cloud.openfeign.httpclient.hc5.socket-timeout | `5` | Default value for socket timeout.
-|spring.cloud.openfeign.httpclient.hc5.socket-timeout-unit |  | Default value for socket timeout unit.
-|spring.cloud.openfeign.httpclient.max-connections | `200` | 
-|spring.cloud.openfeign.httpclient.max-connections-per-route | `50` | 
-|spring.cloud.openfeign.httpclient.ok-http.read-timeout | `60s` | {@link OkHttpClient} read timeout; defaults to 60 seconds.
-|spring.cloud.openfeign.httpclient.time-to-live | `900` | 
-|spring.cloud.openfeign.httpclient.time-to-live-unit |  | 
-|spring.cloud.openfeign.micrometer.enabled | `true` | Enables Micrometer capabilities for Feign.
-|spring.cloud.openfeign.oauth2.enabled | `false` | Enables feign interceptor for managing oauth2 access token.
-|spring.cloud.openfeign.oauth2.load-balanced | `false` | Enables load balancing for oauth2 access token provider.
-|spring.cloud.openfeign.okhttp.enabled | `false` | Enables the use of the OK HTTP Client by Feign.
-
-|===

docs/modules/ROOT/pages/appendix.adoc

@@ -6,7 +6,7 @@
 
 
 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.
+This appendix provides a list of common Spring Cloud OpenFeign 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.

docs/modules/ROOT/pages/configprops.adoc

@@ -0,0 +1,6 @@
+[[configuration-properties]]
+= Configuration Properties
+
+Below you can find a list of configuration properties.
+
+include::partial$_configprops.adoc[]

docs/modules/ROOT/pages/index.adoc

@@ -0,0 +1,9 @@
+[[cloud-native-applications]]
+= Cloud Native Applications
+
+include::partial$_attributes.adoc[]
+
+// TODO: figure out remote includes in docs and replace pasted text
+// include::https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing-docs.adoc[]
+NOTE: Spring Cloud is released under the non-restrictive Apache 2.0 license.
+If you would like to contribute to this section of the documentation or if you find an error, you can find the source code and issue trackers for the project at {github-issues}[github].

docs/modules/ROOT/pages/intro.adoc

@@ -1,3 +1,6 @@
+[[intro]]
+= Introduction
+
 This project provides OpenFeign integrations for Spring Boot apps through autoconfiguration
 and binding to the Spring Environment and other Spring programming model idioms.
 

docs/modules/ROOT/pages/spring-cloud-openfeign.adoc

@@ -1,9 +1,5 @@
-[[spring-cloud-openfeign]]
+[[features]]
-= Spring Cloud OpenFeign
+= Spring Cloud OpenFeign Features
-
-*{spring-cloud-version}*
-
-
 
 [[spring-cloud-feign]]
 == Declarative REST Client: Feign
@@ -846,7 +842,7 @@ If Feign client refresh is enabled, each Feign client is created with:
 
 * `feign.Request.Options` as a refresh-scoped bean. This means properties such as `connectTimeout` and `readTimeout` can be refreshed against any Feign client instance.
 * A url wrapped under `org.springframework.cloud.openfeign.RefreshableUrl`. This means the URL of Feign client, if defined
-with `spring.cloud.openfeign.client.config.{feignName}.url` property, can be refreshed against any Feign client instance.
+with `spring.cloud.openfeign.client.config.\{feignName}.url` property, can be refreshed against any Feign client instance.
 
 You can refresh these properties through `POST /actuator/refresh`.
 

docs/modules/ROOT/partials/_attributes.adoc

@@ -0,0 +1,3 @@
+:sc-ext: java
+:project-full-name: Spring Cloud OpenFeign
+:all: {asterisk}{asterisk}

docs/pom.xml

@@ -3,25 +3,32 @@
 		 xmlns="http://maven.apache.org/POM/4.0.0"
 		 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
+	<groupId>org.springframework.cloud</groupId>
+	<artifactId>spring-cloud-openfeign-docs</artifactId>
 	<parent>
 		<groupId>org.springframework.cloud</groupId>
 		<artifactId>spring-cloud-openfeign</artifactId>
 		<version>4.1.0-SNAPSHOT</version>
+		<relativePath>..</relativePath>
 	</parent>
 	<scm>
 		<url>https://github.com/spring-cloud/spring-cloud-openfeign</url>
 	</scm>
-	<artifactId>spring-cloud-openfeign-docs</artifactId>
 	<packaging>jar</packaging>
 	<name>Spring Cloud OpenFeign Docs</name>
-	<description>Spring Cloud Docs</description>
+	<description>Spring Cloud OpenFeign Docs</description>
 	<properties>
 		<docs.main>spring-cloud-openfeign</docs.main>
 		<main.basedir>${basedir}/..</main.basedir>
-		<configprops.inclusionPattern>feign.*</configprops.inclusionPattern>
+		<configprops.inclusionPattern>spring.cloud.*</configprops.inclusionPattern>
-		<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
 		<!-- Don't upload docs jar to central / repo.spring.io -->
 		<maven-deploy-plugin-default.phase>none</maven-deploy-plugin-default.phase>
+
+		<!-- Observability -->
+		<micrometer-docs-generator.version>1.0.2</micrometer-docs-generator.version>
+		<micrometer-docs-generator.inputPath>${maven.multiModuleProjectDirectory}/</micrometer-docs-generator.inputPath>
+		<micrometer-docs-generator.inclusionPattern>.*</micrometer-docs-generator.inclusionPattern>
+		<micrometer-docs-generator.outputPath>${maven.multiModuleProjectDirectory}/docs/modules/ROOT/partials/</micrometer-docs-generator.outputPath>
 	</properties>
 	<dependencies>
 		<dependency>
@@ -36,6 +43,12 @@
 		<profile>
 			<id>docs</id>
 			<build>
+				<resources>
+					<resource>
+						<directory>src/main/antora/resources/antora-resources</directory>
+						<filtering>true</filtering>
+					</resource>
+				</resources>
 				<plugins>
 					<plugin>
 						<groupId>pl.project13.maven</groupId>
@@ -45,17 +58,44 @@
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-dependency-plugin</artifactId>
 					</plugin>
-					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-resources-plugin</artifactId>
-					</plugin>
 					<plugin>
 						<groupId>org.codehaus.mojo</groupId>
 						<artifactId>exec-maven-plugin</artifactId>
+						<!-- TODO: Remove this execution if you have no observability -->
+						<executions>
+							<execution>
+								<id>generate-observability-docs</id>
+								<phase>${generate-docs.phase}</phase>
+								<goals>
+									<goal>java</goal>
+								</goals>
+								<configuration>
+									<mainClass>io.micrometer.docs.DocsGeneratorCommand</mainClass>
+									<includePluginDependencies>true</includePluginDependencies>
+									<arguments>
+										<argument>${micrometer-docs-generator.inputPath}</argument>
+										<argument>${micrometer-docs-generator.inclusionPattern}</argument>
+										<argument>${micrometer-docs-generator.outputPath}</argument>
+									</arguments>
+								</configuration>
+							</execution>
+						</executions>
+						<dependencies>
+							<dependency>
+								<groupId>io.micrometer</groupId>
+								<artifactId>micrometer-docs-generator</artifactId>
+								<version>${micrometer-docs-generator.version}</version>
+								<type>jar</type>
+							</dependency>
+						</dependencies>
+					</plugin>
+					<plugin>
+						<groupId>io.spring.maven.antora</groupId>
+						<artifactId>antora-component-version-maven-plugin</artifactId>
 					</plugin>
 					<plugin>
-						<groupId>org.asciidoctor</groupId>
+						<groupId>io.spring.maven.antora</groupId>
-						<artifactId>asciidoctor-maven-plugin</artifactId>
+						<artifactId>antora-maven-plugin</artifactId>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>

docs/src/main/antora/resources/antora-resources/antora.yml

@@ -0,0 +1,20 @@
+version: @antora-component.version@
+prerelease: @antora-component.prerelease@
+
+asciidoc:
+  attributes:
+    attribute-missing: 'warn'
+    chomp: 'all'
+    project-root: @maven.multiModuleProjectDirectory@
+    github-repo: @docs.main@
+    github-raw: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@
+    github-code: https://github.com/spring-cloud/@docs.main@/tree/@github-tag@
+    github-issues: https://github.com/spring-cloud/@docs.main@/issues/
+    github-wiki: https://github.com/spring-cloud/@docs.main@/wiki
+    spring-cloud-version: @project.version@
+    github-tag: @github-tag@
+    version-type: @version-type@
+    docs-url: https://docs.spring.io/@docs.main@/docs/@project.version@
+    raw-docs-url: https://raw.githubusercontent.com/spring-cloud/@docs.main@/@github-tag@
+    project-version: @project.version@
+    project-name: @docs.main@