Commit Graph

233 Commits

Author SHA1 Message Date
John Blum
83c944a253 Add reference documentation for the new (JSON) Cache Data Import/Export feature.
Resolves gh-67.
2020-05-13 22:37:19 -07:00
John Blum
293eebb676 Add Spring Boot application class configuring and bootstrapping an Apache Geode (or Pivotal GemFire) ClientCache instance for documentation purposes. 2020-05-05 10:56:56 -07:00
John Blum
0053484007 Add optional 'spring-geode-starter-logging' dependency. 2020-04-29 20:55:21 -07:00
John Blum
f2f502e288 Fix misspelling. 2020-04-20 21:18:11 -07:00
John Blum
ff9594e26d Correct grammar, spelling and verbiage in the Multi-Site Caching Guide.
Resolves gh-80.
2020-04-19 20:46:00 -07:00
John Blum
01e0f2f5f0 Clean up all HTTP URLS; replace with HTTPS.
Resolves gh-80.
2020-04-19 17:01:27 -07:00
John Blum
efcfcb0952 Add Guide for the Multi-Site Caching Sample.
Resolves gh-80.
2020-04-19 16:58:08 -07:00
John Blum
9091dc0d78 Add details concerning SBDG's type-safe GemFireProperties class hierarchy and Geode Properties.
Edit documentation.

Resolves gh-79.
2020-04-15 22:54:46 -07:00
John Blum
4eaecfc1e7 Add Asciidoc variables to consistently refer to the Apache Geode and GemFire product names.
Resolves gh-79.
2020-04-15 22:54:46 -07:00
John Blum
2978fa9b53 Add details concerning property precedence.
Resolves gh-79.
2020-04-15 22:54:46 -07:00
John Blum
43400dd31b Add documentation for using GemFire Properties in application.properties.
Resolves gh-79.
2020-04-15 22:54:46 -07:00
John Blum
46288080de Add Asciidoc documentation attributes for STDG version. 2020-04-15 22:54:46 -07:00
John Blum
49b9c7340e Upgrade to Apache Geode documentation version 1.12. 2020-04-15 22:54:46 -07:00
John Blum
9266aefcdc Upgrade to Pivotal GemFire documentation version 9.10. 2020-04-15 22:54:46 -07:00
John Blum
db3dd51482 Upgrade to Pivotal Cloud Cache (PCC) documentation version 1.11. 2020-04-15 22:54:46 -07:00
John Blum
45095106c6 Change URL to Pivotal Platform (Tanzu Application Service (TAS)) documentation and upgrade to 2.9.
Pivotal Platform (Tanzu) Application Service (PAS/TAS) was formerly known as Pivotal CloudFoundry (PCF) Application Service (PAS).
2020-04-15 22:54:46 -07:00
John Blum
ec6a674832 Fix spelling error. 2020-04-15 22:54:46 -07:00
John Blum
9fcc29c2fd Fix URL to Apache Geode gemfire.properties reference documentation. 2020-04-15 22:54:46 -07:00
John Blum
bd98382dc1 Fix source block formatting. 2020-04-14 20:22:56 -07:00
John Blum
9cc90c2922 Fix formatting. 2020-04-14 20:11:44 -07:00
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