Spring/spring-boot-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update Documentation URLs across all SBDG versions to use the new symbolic linked docs and API references.

Browse Source 
Edit the Examples section to list Examples in order of precedence.

Add description for each Example.
This commit is contained in:
John Blum
2019-06-25 12:22:01 -07:00
parent fd613eb3d2
commit cda689ca51
1 changed files with 19 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.adoc
View File

@@ -50,26 +50,34 @@ This, along with many other benefits, are provided by this project.
|===
| Version | Reference Documentation | Javadoc | Samples
| `1.0.1.RELEASE` | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.RELEASE/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.RELEASE/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.1.RELEASE/reference/html5/#geode-samples[Samples]
| `1.0.2.BUILD-SNAPSHOT`| https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.2.BUILD-SNAPSHOT/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.2.BUILD-SNAPSHOT/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.0.2.BUILD-SNAPSHOT/reference/html5/#geode-samples[Samples]
| `1.1.0.M2` | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.M2/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.M2/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.M2/reference/html5/#geode-samples[Samples]
| `1.1.0.BUILD-SNAPSHOT`| https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.BUILD-SNAPSHOT/reference/html5/[Ref Docs] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.BUILD-SNAPSHOT/api/[Javadoc] | https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.BUILD-SNAPSHOT/reference/html5/#geode-samples[Samples]
| `current` | https://docs.spring.io/spring-boot-data-geode-build/current/reference/html5/[Ref Docs] | https://docs.spring.io/spring-boot-data-geode-build/current/api/[Javadoc] | https://docs.spring.io/spring-boot-data-geode-build/current/reference/html5/#geode-samples[Samples]
| `1.0.1.RELEASE` | https://docs.spring.io/spring-boot-data-geode-build/1.0.x/reference/html5/[Ref Docs] | https://docs.spring.io/spring-boot-data-geode-build/1.0.x/api/[Javadoc] | https://docs.spring.io/spring-boot-data-geode-build/1.0.x/reference/html5/#geode-samples[Samples]
| `1.0.2.BUILD-SNAPSHOT`| https://docs.spring.io/spring-boot-data-geode-build/1.0.x-SNAPSHOT/reference/html5/[Ref Docs] | https://docs.spring.io/spring-boot-data-geode-build/1.0.x-SNAPSHOT/api/[Javadoc] | https://docs.spring.io/spring-boot-data-geode-build/1.0.x-SNAPSHOT/reference/html5/#geode-samples[Samples]
| `1.1.0.M2` | https://docs.spring.io/spring-boot-data-geode-build/1.1.x/reference/html5/[Ref Docs] | https://docs.spring.io/spring-boot-data-geode-build/1.1.x/api/[Javadoc] | https://docs.spring.io/spring-boot-data-geode-build/1.1.x/reference/html5/#geode-samples[Samples]
| `1.1.0.BUILD-SNAPSHOT`| https://docs.spring.io/spring-boot-data-geode-build/1.1.x-SNAPSHOT/reference/html5/[Ref Docs] | https://docs.spring.io/spring-boot-data-geode-build/1.1.x-SNAPSHOT/api/[Javadoc] | https://docs.spring.io/spring-boot-data-geode-build/1.1.x-SNAPSHOT/reference/html5/#geode-samples[Samples]
|===
[[examples]]
=== Examples
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],
repository, which contains a Spring Boot, PCC `ClientCache` application.
The single, most relevant "_source of truth_" on how to get started quickly and effectively, using Spring Boot
for Apache Geode & Pivotal GemFire (SBDG) to solve problems, is by starting with the
https://docs.spring.io/spring-boot-data-geode-build/current/reference/html5/#geode-samples[Samples].
There, you will find different examples with documentation and code showing you how to use SBDG to address
specific application concerns, like Caching.
Another example, https://github.com/jxblum/contacts-application/tree/master/boot-example[boot-example], can be found
in the Contacts Application Reference Implementation for _Spring Data for Apache Geode/Pivotal GemFire_ (SDG).
You can find an example of using SBDG in the Pivotal Cloud Cache (PCC) https://github.com/pivotal-cf/PCC-Sample-App-PizzaStore[Pizza Store]
repository, which is a Spring Boot `ClientCache` application that talks to PCC when the app is deploy to PCF.
Yet another example, https://github.com/jxblum/temperature-service/tree/using-spring-boot[Temperature Service].
The https://github.com/jxblum/contacts-application/tree/master/boot-example[boot-example] found in the
Contacts Application Reference Implementation for _Spring Data for Apache Geode & Pivotal GemFire_ (SDG) uses SBDG
to manage Books in a _System of Record_ Use Case.
And finally, the documentation contains https://docs.spring.io/autorepo/docs/spring-boot-data-geode-build/1.1.0.BUILD-SNAPSHOT/reference/html5/#geode-samples[samples]
you may use to get started with SBDG.
Then, the https://github.com/jxblum/temperature-service/tree/using-spring-boot[Temperature Service] example is
an _Internet of Things_ (IoT) and _Event Stream Processing_ (ESP) Use Case that manages Temperature Sensors and Monitors.
Overtime, we will be adding even more relevant and practical examples, so please keep checking back.
[[spring-boot-project-site]]
== Spring Boot Project Site