766416b974
- Allow asciidoctor to read from URI (contributing section) - Add 'building documentation' section - Add newly-updated README - Small spelling fixes
// Do not edit this file (e.g. go instead to docs/src/main/asciidoc) = Spring Cloud for Cloudfoundry image:https://travis-ci.org/spring-cloud/spring-cloud-cloudfoundry.svg?branch=master["Build Status", link="https://travis-ci.org/spring-cloud/spring-cloud-cloudfoundry"] Spring Cloud for Cloudfoundry makes it easy to run https://github.com/spring-cloud[Spring Cloud] apps in https://github.com/cloudfoundry[Cloud Foundry] (the Platform as a Service). Cloud Foundry has the notion of a "service", which is middlware that you "bind" to an app, essentially providing it with an environment variable containing credentials (e.g. the location and username to use for the service). The `spring-cloud-cloudfoundry-web` project provides basic support for some enhanced features of webapps in Cloud Foundry: binding automatically to single-sign-on services and optionally enabling sticky routing for discovery. The `spring-cloud-cloudfoundry-discovery` project provides an implementation of Spring Cloud Commons `DiscoveryClient` so you can `@EnableDiscoveryClient` and provide your credentials as `spring.cloud.cloudfoundry.discovery.[email,password]` and then you can use the `DiscoveryClient` directly or via a `LoadBalancerClient` (also `*.url` if you are not connecting to [Pivotal Web Services](https://run.pivotal.io)). > NOTE: if you are looking for a way to bind to services then this is the wrong library. Check out the [Spring Cloud Connectors](https://github.com/spring-cloud/spring-cloud-connectors) instead. = Building documentation `./mvnw install -P docs -DskipTests=true --settings .settings.xml` If there is an ruby error like -------------------------------------------------------------- LoadError: no such file to load -- asciidoctor -------------------------------------------------------------- then the user must install the _asciidoctor_ gem and set the environment variable `GEM_HOME`to the ruby gem folder. For example: ------------------------------------------------------------- # Get gem info gem environment export GEM_HOME=<PATH FOR GEM ENVIRONMENT> ------------------------------------------------------------- == Contributing link:https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/docs/src/main/asciidoc/contributing.adoc[]