Gh-460: Improve cache documentation (#463)

gchq · Mar 21, 2024 · c3c472c · c3c472c
1 parent 6fea1cc
commit c3c472c
Show file tree

Hide file tree

Showing 2 changed files with 974 additions and 961 deletions.
diff --git a/docs/administration-guide/gaffer-stores/store-guide.md b/docs/administration-guide/gaffer-stores/store-guide.md
@@ -69,7 +69,11 @@ In order for the cache service to run you must select your desired implementatio
 gaffer.cache.service.default.class=uk.gov.gchq.gaffer.cache.impl.HashMapCacheService
 ```
 
-For the JCS and Hazelcast cache, you can specify a configuration file with properties for the cache implementation itself:
+Both the JCS and Hazelcast caches require configuration files.
+In the case of a JCS file this is a [ccf file](https://commons.apache.org/proper/commons-jcs/BasicJCSConfiguration.html) 
+while for Hazelcast this is commonly a [XML/YAML file](https://docs.hazelcast.com/imdg/4.2/configuration/understanding-configuration#static-configuration).
+
+You should then specify the location of any configuration file(s) in your store.properties file as follows:
 ```
 gaffer.cache.config.file=/path/to/file
 ```