From e9ccfc21eaae64d34e130c0437d87326086cf276 Mon Sep 17 00:00:00 2001 From: tb06904 <141412860+tb06904@users.noreply.github.com> Date: Fri, 29 Sep 2023 16:33:50 +0000 Subject: [PATCH] Apply suggestions from code review Co-authored-by: GCHQDeveloper314 <94527357+GCHQDeveloper314@users.noreply.github.com> --- docs/administration-guide/gaffer-config/graph-metadata.md | 5 ++--- .../gaffer-deployment/gaffer-docker/gaffer-images.md | 2 +- docs/administration-guide/gaffer-deployment/quickstart.md | 2 +- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/administration-guide/gaffer-config/graph-metadata.md b/docs/administration-guide/gaffer-config/graph-metadata.md index 42c5f7f848..782e0c2a1c 100644 --- a/docs/administration-guide/gaffer-config/graph-metadata.md +++ b/docs/administration-guide/gaffer-config/graph-metadata.md @@ -3,8 +3,7 @@ The graph configuration file is a JSON file that configures few bits of the Gaffer graph. Primarily it is used to set the name and description along with any additional hooks to run before an operation chain e.g. to impose limits on -max results etc. For the example a simple graph configuration file might look -like: +max results etc. For example, a simple graph configuration file may look like: ```json title="graphConfig.json" { @@ -15,7 +14,7 @@ like: ## Configuring a Standard Deployment -To change any of the values for a standard Gaffer deployment all thats needed +To change any of the values for a standard Gaffer deployment all that's needed is to configure the JSON file for the `graphConfig`. The key value pairs in the file can then be configured as you wished and upon restarting the graph the values will be updated (assuming the file is loaded correctly). diff --git a/docs/administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md b/docs/administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md index 2cd56fea9e..6315ee5259 100644 --- a/docs/administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md +++ b/docs/administration-guide/gaffer-deployment/gaffer-docker/gaffer-images.md @@ -92,7 +92,7 @@ will need to customise the docker images and use them in place of the defaults. At the moment, the `gchq/gaffer-rest` image uses a runnable jar file located at `/gaffer/jars`. When it runs it includes the `/gaffer/jars/lib` on the -classpath. There is nothing in there by default because all the dependencies are +classpath. This is empty by default because all the dependencies are bundled in to the JAR. However, if you wanted to add your own jars, you can add then to this directory like the following: diff --git a/docs/administration-guide/gaffer-deployment/quickstart.md b/docs/administration-guide/gaffer-deployment/quickstart.md index fd2f5d83df..25ab7c3438 100644 --- a/docs/administration-guide/gaffer-deployment/quickstart.md +++ b/docs/administration-guide/gaffer-deployment/quickstart.md @@ -65,6 +65,6 @@ available and covered in the [Gaffer configuration section](../gaffer-config/con Example `store.properties` for MapStore ```properties - gaffer.store.class=uk.gov.gchq.gaffer.mapstore.SingleUseMapStore + gaffer.store.class=uk.gov.gchq.gaffer.mapstore.MapStore gaffer.store.properties.class=uk.gov.gchq.gaffer.mapstore.MapStoreProperties ```