Skip to content

Commit 6a9edd5

Browse files
committed
Edit README.adoc.
Add table to reference documentation, Javadoc and Samples by version. Add anchors. Revise the project goals.
1 parent d218242 commit 6a9edd5

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.adoc

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
image:https://api.travis-ci.org/spring-projects/spring-boot-data-geode.svg?branch=master["Build Status", link="https://travis-ci.org/spring-projects/spring-boot-data-geode"]
22

3+
[[about]]
34
= Spring Boot for Apache Geode & Pivotal GemFire
45

56
_Spring Boot for Apache Geode & Pivotal GemFire_ extends https://projects.spring.io/spring-boot/[_Spring Boot_] with
@@ -11,6 +12,7 @@ This project builds on both https://github.com/spring-projects/spring-data-geode
1112
and https://projects.spring.io/spring-data-gemfire/[_Spring Data for Pivotal GemFire_]
1213
as well as https://spring.io/projects/spring-boot[Spring Boot].
1314

15+
[[project-goals]]
1416
=== Project Goals
1517

1618
This project adds _Spring Boot_ **auto-configuration** support for both https://geode.apache.org/[Apache Geode]
@@ -20,11 +22,13 @@ Among other things, this project builds on https://projects.spring.io/spring-boo
2022
as well as https://projects.spring.io/spring-data-gemfire/[_Spring Data for Apache Geode & Pivotal GemFire_]
2123
and additionally offers...
2224

23-
1. _Auto-configures_ an _Apache Geode_ or _Pivotal GemFire_ https://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/client/ClientCache.html[ClientCache]
25+
1. _Auto-configures_ an _Apache Geode_ or _Pivotal GemFire_ (PCC)
26+
https://geode.apache.org/releases/latest/javadoc/org/apache/geode/cache/client/ClientCache.html[ClientCache]
2427
instance automatically when either _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_
2528
are on the application's CLASSPATH.
2629

27-
2. _Auto-configures_ either _Apache Geode_ or _Pivotal GemFire_ as a _caching provider_ in https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#cache[_Spring's Cache Abstraction_]
30+
2. _Auto-configures_ either _Apache Geode_ or _Pivotal GemFire_ (PCC) as a _caching provider_ in
31+
https://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#cache[_Spring's Cache Abstraction_]
2832
when either _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_ are on the application's CLASSPATH.
2933

3034
3. _Auto-configures_ _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_
@@ -33,42 +37,49 @@ when _Spring Data for Apache Geode_ or _Spring Data for Pivotal GemFire_ are on
3337
and _Spring Boot_ detects SDG _Repositories_ in your _Spring Boot_ application.
3438

3539
4. Provides additional support for _Spring Boot_/_Spring Data for Apache Geode_/_Pivotal GemFire_ applications
36-
deployed to PCF using either the Pivotal Cloud Cache (PCC) or Session State Caching (SSC) services.
37-
Also, when using SSC, you can also take advantage of
40+
deployed to PCF using Pivotal Cloud Cache (PCC). Additionally, if your application requires (HTTP) Session State
41+
Caching services, you can also take advantage of
3842
https://github.com/spring-projects/spring-session-data-geode[_Spring Session for Apache Geode/Pivotal GemFire_].
3943

40-
5. As an added benefit, _Spring Boot for Pivotal GemFire_ will automatically authenticate your _Spring Boot_, _Pivotal GemFire_ based application
41-
when deployed to PCF and the application is granted access to a secure PCC instance for all of its caching concerns.
42-
43-
This, along with many other things will be provided in and by this project.
44+
This, along with many other benefits, are provided by this project.
4445

46+
[[documentation]]
4547
=== Documentation
4648

47-
You can find the documentation for this project
48-
https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.BUILD-SNAPSHOT/reference/html5/[here],
49-
and API is https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.BUILD-SNAPSHOT/api/[here].
49+
.Example Apache Geode Applications using Spring Boot
50+
|===
51+
| Version | Reference Documentation | Javadoc | Samples
52+
53+
| 1.0.0.RELEASE | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.RELEASE/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.RELEASE/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.RELEASE/reference/html5/#geode-samples[Samples]
54+
| 1.0.1.BUILD-SNAPSHOT| https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.BUILD-SNAPSHOT/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.BUILD-SNAPSHOT/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.BUILD-SNAPSHOT/reference/html5/#geode-samples[Samples]
55+
56+
|===
5057

58+
[[examples]]
5159
=== Examples
5260

5361
You can find an example of using this project in the Pivotal Cloud Cache (PCC) https://github.com/pivotal-cf/PCC-Sample-App-PizzaStore[Pizza Store],
54-
Spring Boot, Pivotal GemFire `ClientCache` application.
62+
repository, which contains a Spring Boot, PCC `ClientCache` application.
5563

5664
Another example, https://github.com/jxblum/contacts-application/tree/master/boot-example[boot-example], can be found
5765
in the Contacts Application Reference Implementation for _Spring Data for Apache Geode/Pivotal GemFire_ (SDG).
5866

5967
And finally, the documentation contains https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.0.BUILD-SNAPSHOT/reference/html5/#geode-samples[samples]
6068
you may use to get started with SBDG.
6169

70+
[[spring-boot-project-site]]
6271
== Spring Boot Project Site
6372

6473
You can find the documentation, issue management, support, samples, and guides for using _Spring Boot_
6574
at https://projects.spring.io/spring-boot/
6675

76+
[[code-of-conduct]]
6777
== Code of Conduct
6878

6979
This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct].
7080
By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
7181

82+
[[license]]
7283
== License
7384

7485
_Spring Boot_, _Spring Boot for Apache Geode_ and _Spring Boot for Pivotal GemFire_ is Open Source Software

0 commit comments

Comments
 (0)