Migrated docs to new styles

This commit is contained in:
Oleg Zhurakousky
2019-03-14 16:04:46 +01:00
parent fc6c247938
commit 8ee8215c9c
13 changed files with 483 additions and 246 deletions

View File

@@ -1,3 +1,3 @@
This project provides an adapter layer for a Spring Cloud Function application onto AWS Lambda. You can write an app with a single `@Bean` of type `Function`, `Consumer` or `Supplier` and it will be deployable in AWS if you get the JAR file laid out right. The best way to make it work is to include `spring-cloud-function-context` as a dependency, but not the higher level adapters (e.g. `spring-cloud-function-stream`).
include::aws-intro.adoc[]
include::adapters/aws-intro.adoc[]

View File

@@ -1,8 +1,10 @@
*{spring-cloud-function-version}*
The https://aws.amazon.com/[AWS] adapter takes a Spring Cloud Function app and converts it to a form that can run in AWS Lambda.
== Introduction
include::aws-intro.adoc[]
include::adapters/aws-intro.adoc[]
== Functional Bean Definitions

View File

@@ -1,7 +1,7 @@
This project provides an adapter layer for a Spring Cloud Function application onto Azure.
You can write an app with a single `@Bean` of type `Function` and it will be deployable in Azure if you get the JAR file laid out right.
include::azure-intro.adoc[]
include::adapters/azure-intro.adoc[]
== Sample Function

View File

@@ -1,3 +1,5 @@
*{spring-cloud-function-version}*
The https://azure.microsoft.com[Azure] adapter bootstraps a Spring Cloud Function context and channels function calls from the Azure framework into the user functions, using Spring Boot configuration where necessary. Azure Functions has quite a unique, but invasive programming model, involving annotations in user code that are specific to the platform. The easiest way to use it with Spring Cloud is to extend a base class and write a method in it with the `@FunctionName` annotation which delegates to a base class method.
include::azure-intro.adoc[]
include::adapters/azure-intro.adoc[]

View File

@@ -1,6 +1,6 @@
== Quick Start
include::openwhisk-quick-start.adoc[]
include::adapters/openwhisk-quick-start.adoc[]
== Examples

View File

@@ -1,4 +1,6 @@
*{spring-cloud-function-version}*
The https://openwhisk.apache.org/[OpenWhisk] adapter is in the form of an executable jar that can be used in a a docker image to be deployed to Openwhisk. The platform works in request-response mode, listening on port 8080 on a specific endpoint, so the adapter is a simple Spring MVC application.
== Quick Start
include::openwhisk-quick-start.adoc[]
include::adapters/openwhisk-quick-start.adoc[]

View File

@@ -0,0 +1,21 @@
= Spring Cloud Function Reference Documentation
Mark Fisher, Dave Syer, Oleg Zhurakousky
*{spring-cloud-function-version}*
:docinfo: shared
The reference documentation consists of the following sections:
[horizontal]
<<spring-cloud-function.adoc#,Reference Guide>> :: Spring Cloud Function Reference
<<aws.adoc#,AWS Adapter>> :: AWS Adapter Reference
<<azure.adoc#, Azure Adapter>> :: Azure Adapter Reference
<<openwhisk.adoc#, Apache OpenWhisk Adapter>> :: Apache OpenWhisk Adapter Reference
Relevant Links:
[horizontal]
https://projectreactor.io/[Reactor] :: Project Reactor
https://projectriff.io/[riff] :: Project riff

View File

@@ -2,6 +2,8 @@
Mark Fisher, Dave Syer, Oleg Zhurakousky
*{spring-cloud-function-version}*
---
:github: https://github.com/spring-cloud/spring-cloud-function
@@ -267,14 +269,3 @@ https://projectriff.io[Riff] supports Java functions and its
https://github.com/projectriff/java-function-invoker[Java Function
Invoker] acts natively is an adapter for Spring Cloud Function jars.
=== AWS Lambda
include::adapters/aws.adoc[leveloffset=+2]
=== Azure Functions
include::adapters/azure.adoc[leveloffset=+2]
=== Apache Openwhisk
include::adapters/openwhisk.adoc[leveloffset=+2]