John Blum
193a857901
Include instructions on how to run the Getting Started Sample, Spring Boot application using Gradle and Maven.
...
Resolved gh-75.
2020-03-18 14:06:40 -07:00
John Blum
d9f0858a9a
Add description of Gradle build file.
2020-03-06 19:03:57 -08:00
John Blum
7318f3c2af
Fix broken Guide links referring back to anchors in the index HTML.
2020-03-06 18:59:25 -08:00
John Blum
a631cbdff2
Add commented out configuration to (eventually) generate PDFs for Guides.
2020-03-06 18:25:23 -08:00
John Blum
b72139ac88
Refer to images by location using the 'images-dir' Asciidoc attribute.
2020-03-06 18:25:23 -08:00
John Blum
d6c6582086
Move all Guide images into 'guides/images/'.
2020-03-06 18:10:30 -08:00
John Blum
98b802dd97
Fix broken 'Back to index' link in left nav, table of contents.
...
Rename 'Back' link to 'Back to Samples'.
2020-03-06 17:41:43 -08:00
John Blum
405114835e
Re-arrange the asciidoctor* Gradle build task configurations.
2020-03-06 17:05:11 -08:00
Rob Winch
67a306e0eb
Workaround docinfo-footer.html for nested directories.
...
The default docinfo-footer.html points to a js/ directory. This breaks the reference to JavaScript in nested folders.
To workaround this issue we include a custom docinfo-footer.html that points to '../js'.
See https://github.com/spring-gradle-plugins/spring-build-conventions/issues/80
2020-03-06 17:02:11 -08:00
Rob Winch
a0280fba46
Workaround duplicate adoc files.
...
guides/*.adoc are copied to guides/*.adoc and ./ when being processed. This breaks links to JavaScript.
To workaround this, we explicitly state which sources we want to process and avoid the copy found in './'.
See https://github.com/spring-gradle-plugins/spring-build-conventions/issues/80
2020-03-06 16:52:56 -08:00
Rob Winch
fb1e56bb92
Ensure Asciidoctor attributes are configured for PDFs too.
...
In previous versions of the Asciidoctor Gradle Plugin, Asciidoctor was an extension that was read by all Asciidoctor
tasks. This meant that configuring the following impacted all Asciidoctor tasks (including PDF):
asciidoctor {
attributes ...
}
The latest version of Asciidoctor moved conventions to AsciidoctorJ. The reason for this is there was a task named
'asciidoctor' and a convention named 'asciidoctor' which caused confusion for users on which was being configured.
This commit switches to the new 'asciidoctorj' convention/extension so that attributes are configured for all
Asciidoctor tasks (i.e. both the 'asciidoctor' and 'asciidoctorPdf' tasks).
2020-03-06 16:33:26 -08:00
Rob Winch
3915c3dcc0
Configure asciidoctorPdf for index.adoc.
...
We only want index.adoc to be processed by asciidoctorPdf so explicitly configure only index.adoc.
2020-03-06 16:33:26 -08:00
Rob Winch
9a7a9b7dad
Remove absolute path to stylesheet.
...
Using an absolute path breaks the css resolution for a few reasons:
a) Locally it is missing because everything is copied into a temporary directory for processing. The temp directory
exists when the HTML is written out, but is removed once processing is done. The output is still referring to
the styles in the temp dir after processing is done.
b) When the HTML is deployed it will refer to the styles on the local directory that the docs were built. When other
users view it on the web server, the dir will not exist.
This commit removes the 'stylesheet' attribute definition to fix this.
2020-03-06 16:33:26 -08:00
Rob Winch
2ad8af578f
Fix missing attribute '{apache-geode-docs}'.
...
The attribute syntax was incorrect and did not have a space after its definition thereby causing the attribute
to not be found.
2020-03-06 16:33:26 -08:00
Rob Winch
08fbdad6c0
Fix possible invalid references.
...
Guides are processed separately from index.adoc and the includes, so the guides must provide a path to the adoc file
that has the reference.
2020-03-06 16:33:26 -08:00
John Blum
6d2c788021
Move all included adoc files into _includes.
2020-03-06 16:33:26 -08:00
John Blum
6e3a511c38
Define location to stylesheet and JS files as Asciidoc attributes.
...
Tag guides dir with 'docinfodir'.
2020-03-06 16:33:26 -08:00
John Blum
a9d45b24b4
Define location to the spring.css stylesheet using an absolute path.
...
Also applied the same approach used in
d8f160c178 .
However, this had no effect.
2020-03-06 16:33:26 -08:00
John Blum
52145da1c9
Align Table of Contents (TOC) to the left.
...
Set TOC level to 2 in Sample Guides.
2020-03-06 16:31:18 -08:00
Rob Winch
e6dbce7925
Customize Gradle Asciidoctor build task to properly identify doc source.
...
Other Spring Build Conventions based projects assume includes are in _includes but SBDG has includes outside of
_includes. This means we must change the sources to only be 'index.adoc'.
Update docs build to configure every task of type AbstractAsciidoctorTask so that asciidoctorPdf picks up
the custom attributes set and the updated sources.
2020-03-06 16:31:29 -08:00
Rob Winch
9d600cd7c4
Migrate deprecated footnoteref to footnote.
2020-03-06 16:31:18 -08:00
John Blum
b7a0af0df0
Escape the Spring property placeholder syntax used in Spring application properties files.
2020-02-21 15:44:34 -08:00
John Blum
cba67e9a8c
Escape the REST API HTTP URL variable syntax.
2020-02-21 15:44:34 -08:00
John Blum
61b2e82396
Fix non-unique anchor.
2020-02-21 15:44:34 -08:00
John Blum
7897f46454
Update Copyright Year in Reference Documentation (Guide) to 2020.
2020-02-20 23:49:08 -08:00
John Blum
fef9ba47be
Add documentation on the required dependencies used to run an Apache Geode Manager.
...
Resolves gh-72.
2020-02-20 23:34:15 -08:00
John Blum
32d0b5339e
Edit chapter on Building ClientCache Applications.
2020-02-20 22:53:03 -08:00
John Blum
8447eaad10
Update Copyright to 2020.
2020-02-19 23:04:23 -08:00
John Blum
d5ac5f0c1f
Add documentation in the reference guide on the new spring-geode-starter-logging module.
...
Resolves gh-71.
2020-02-19 22:54:20 -08:00
John Blum
99157badbc
Fix typo.
2019-12-13 08:34:05 -08:00
John Blum
84e596e926
Change HTTP URL to HTTPS.
2019-10-17 13:59:12 -07:00
John Blum
f98b6299d2
Cleanup all documentation references to the spring-cloudcache-starter* modules.
...
Resolves gh-63.
2019-10-17 12:04:44 -07:00
John Blum
7b1c2cfd01
Add additional documentation on required modifications to the Maven ~/.m2/settings.xml file in order to authenticate with the Pivotal Commercial Repository server.
...
Clarify in the documentation that explicit declarations on the Pivotal GemFire dependencies is not needed, and is provided by the spring-gemfire-starter.
Resolves gh-62.
2019-10-17 12:01:58 -07:00
John Blum
469880ee03
Add documentation on the required repository declaration when switching from Apache Geode to Pivotal Cloud Cache (or Pivotal GemFire).
...
Resolves gh-62.
2019-10-10 14:41:40 -05:00
John Blum
07827d6465
Edit the chapter on Spring Session.
...
Add new section on using Spring Session with Pivotal Cloud Cache.
2019-10-03 20:49:58 -07:00
John Blum
493dc5a84f
Update 'Getting Started' Guide with the current/latest release of Spring Boot, version 2.2.0.RC1.
...
Update Spring Initializer screenshots at start.spring.io to reflect the use of Spring Boot 2.2.0.RC1 in the guide.
2019-10-03 13:21:58 -07:00
John Blum
ae4b3fac23
Edit the 'Begin with Spring Initializer at start.spring.io' section in the 'Getting Started' Guide to parameterize the Spring Boot version selection based on 'this' version of SBDG.
2019-10-03 00:44:52 -07:00
John Blum
3210f875bb
Change section title from 'Beginning with Spring Initializer at start.spring.io' to 'Begin with Spring Initializer at start.spring.io' in the 'Getting Started' Guide.
2019-10-03 00:22:08 -07:00
John Blum
7acf3c92c5
Improve section on using Spring Initializer at start.spring.io in the 'Getting Started' Guide.
...
Change the selected options (lables & values) to match the screenshot.
Add sidebar on Spring Boot vs. Spring Boot for Apache Geode versions.
2019-10-02 22:01:46 -07:00
John Blum
ecbd7e5299
Edit Appendix, in the section 'Switching from Apache Geode to Pivotal Cloud Cache', for more concise wording.
2019-10-02 15:32:47 -07:00
John Blum
b7420a70d6
Fix broken URL/link to Appendix; Correct spelling.
2019-10-01 20:47:11 -07:00
John Blum
0be5ece5c5
Add reference to the 'Switch from Apache Geode to Pivotal Cloud Cache (a.k.a. Pivotal GemFire)' in the Appendix to the 'Getting Started' Guide when running and deploying the CRM, Spring Boot application to Pivotal Platform.
2019-10-01 20:21:26 -07:00
John Blum
d82eeacb6a
Declare master 'version' properties for Pivotal Cloud Cache and Pivotal GemFire.
2019-10-01 19:50:38 -07:00
John Blum
62cf72aa30
Format guide content.
2019-09-30 14:04:28 -07:00
John Blum
8569ac3a12
Add section in 'Getting Started' Guide on Hybrid Cloud Architectures.
2019-09-28 16:52:40 -07:00
John Blum
06b9e84987
Add 'Back' links.
2019-09-27 17:04:33 -07:00
John Blum
c2f78ef4aa
Refer to the Pivotal GemFire Documentation on acquiring Pivotal GemFire or Pivotal Cloud Cache bits from the commercial Pivotal Maven Repository.
...
Resolves gh-59.
2019-09-27 16:56:06 -07:00
John Blum
7301dd91cf
Edit the Spring Geode Sample on Getting Started with SBDG.
...
Finish section on deploying the CRM, Spring Boot ClientCache application to PCF using PCC.
Resolves gh-54.
2019-09-27 16:30:00 -07:00
John Blum
2f5c88ac16
Edit Sample Guide on 'Getting Started.'
...
Resolves gh-54.
2019-09-24 02:06:00 -07:00
John Blum
b59a41b61f
Add the 'Getting Started' Guide and Example Code to the Samples Table.
...
Resolves gh-54.
2019-09-24 02:05:59 -07:00