Update links to Gaffer docs in all files (#2566)

Co-authored-by: t92549 <80890692+t92549@users.noreply.github.com>

README.md

@@ -34,7 +34,7 @@ Gaffer offers:
  - Retrieval of graph data into Apache Spark for fast and flexible analysis;
  - A fully-featured REST API.
 
-To get going with Gaffer, visit our [getting started pages](https://gchq.github.io/gaffer-doc/summaries/getting-started.html).
+To get going with Gaffer, visit our [getting started pages](https://gchq.github.io/gaffer-doc/v1docs/summaries/getting-started.html).
 
 Gaffer is under active development. Version 1.0 of Gaffer was released in October 2017.
 
@@ -54,7 +54,7 @@ We have a demo available to try that is based around a small uk road use dataset
 
 To build Gaffer run `mvn clean install -Pquick` in the top-level directory. This will build all of Gaffer's core libraries and some examples of how to load and query data.
 
-See our [Store](https://gchq.github.io/gaffer-doc/summaries/stores.html) documentation page for a list of available Gaffer Stores to chose from and the relevant documentation for each.
+See our [Store](https://gchq.github.io/gaffer-doc/v1docs/summaries/stores.html) documentation page for a list of available Gaffer Stores to chose from and the relevant documentation for each.
 
 ### Inclusion in other projects
 
@@ -81,7 +81,7 @@ This will include all other mandatory dependencies. Other (optional) components
 
 Our Javadoc can be found [here](http://gchq.github.io/Gaffer/).
 
-We have some user guides in our [docs](https://gchq.github.io/gaffer-doc/getting-started/user-guide/contents.html).
+We have some user guides in our [docs](https://gchq.github.io/gaffer-doc/v1docs/getting-started/user-guide/contents.html).
 
 Related repositories
 --------------------
@@ -100,7 +100,7 @@ The [gaffer-tools](https://github.com/gchq/gaffer-tools) repository contains use
 Contributing
 ------------
 
-We welcome contributions to the project. Detailed information on our ways of working can be found [here](https://gchq.github.io/gaffer-doc/other/ways-of-working.html). In brief:
+We welcome contributions to the project. Detailed information on our ways of working can be found [here](https://gchq.github.io/gaffer-doc/v1docs/other/ways-of-working.html). In brief:
 
 - Sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/Gaffer);
 - Push your changes to a fork;

core/graph/README.md

@@ -38,11 +38,11 @@ store properties, a schema and some graph specific configuration.
 
 ## Store Properties
 The store properties tells the graph the type of store to connect to
-along with any required connection details. See [Stores](https://gchq.github.io/gaffer-doc/summaries/stores.html) for more information on the different Stores for Gaffer.
+along with any required connection details. See [Stores](https://gchq.github.io/gaffer-doc/v1docs/summaries/stores.html) for more information on the different Stores for Gaffer.
 
 ## Schema
 The schema is passed to the store to instruct the store how to store
-and process the data. See [Schemas](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/schemas.html) for more information.
+and process the data. See [Schemas](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/schemas.html) for more information.
 
 ## Graph Configuration
 The graph configuration allows you to apply special customisations to the Graph instance.

core/operation/README.md

@@ -117,7 +117,7 @@ For use with a `ScoreOperationChain`, some `Operation`s may require a custom
 way of calculating an associated score, therefore an implementation of
 the `ScoreResolver` interface may be required. There is a `DefaultScoreResolver`
 to which the custom implementation should delegate, in a manner specific to the
-new Operation. For more info, see [ScoreOperationChain](https://gchq.github.io/gaffer-doc/components/core/store.html#scoreoperationchain) and [ScoreOperationChainExample](https://gchq.github.io/gaffer-doc/getting-started/operations/scoreoperationchain.html).
+new Operation. For more info, see [ScoreOperationChain](https://gchq.github.io/gaffer-doc/v1docs/components/core/store.html#scoreoperationchain) and [ScoreOperationChainExample](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/scoreoperationchain.html).
 
 #### Documentation
 
@@ -131,7 +131,7 @@ and simple usage examples in [Gaffer-doc](https://github.com/gchq/gaffer-doc).
 Alongside documentation, if the new `Operation` is to be integrated into Gaffer, 
 it is good practice to add it into the
 Python-Shell of [Gaffer-tools](https://github.com/gchq/gaffer-tools).
-For more information, see the [introduction to the Python Shell](https://gchq.github.io/gaffer-doc/components/tool/python-shell.html).
+For more information, see the [introduction to the Python Shell](https://gchq.github.io/gaffer-doc/v1docs/components/tool/python-shell.html).
 
 ## Lazy Results
 Operation results are lazy (where possible) so that results are lazily
@@ -195,7 +195,7 @@ You need to provide a View to override the groupBy fields for all the element gr
 #### My queries are returning duplicate results - why and how can I deduplicate them?
 For example, if you have a Graph containing the Edge A-B and you do a GetElements with a large number of seeds, with the first seed A and the last seed B, then you will get the Edge A-B back twice. This is because Gaffer stores lazily return the results for your query to avoid loading all the results into memory so it will not realise the A-B has been queried for twice.
 
-You can deduplicate your results in memory using the [ToSet](https://gchq.github.io/gaffer-doc/getting-started/operations/toset.html) operation. But, be careful to only use this when you have a small number of results. It might be worth also using the [Limit](https://gchq.github.io/gaffer-doc/getting-started/operation-examples.html#limit-example) operation prior to ToSet to ensure you don't run out of memory.
+You can deduplicate your results in memory using the [ToSet](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/toset.html) operation. But, be careful to only use this when you have a small number of results. It might be worth also using the [Limit](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operation-examples.html#limit-example) operation prior to ToSet to ensure you don't run out of memory.
 
 e.g: 
 
@@ -355,7 +355,7 @@ points for your AddElementsFromHdfs operation.
 
 #### I want to filter the results of my query based on the destination of the result Edges
 OK, there are several ways of doing this and you will need to chose the most appropriate
-way for your needs. Also worth reading [GetElements example](https://gchq.github.io/gaffer-doc/getting-started/operations/getelements.html).
+way for your needs. Also worth reading [GetElements example](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/getelements.html).
 
 If you are querying with just a single EntitySeed with a vertex value of X and require
 the destination to be Y then you should change your query to use an EdgeSeed 
@@ -366,7 +366,7 @@ EdgeSeed as described above.
 
 If you require your destination to match a provided regex than you will need to use
 the regex filter: uk.gov.gchq.koryphe.impl.predicate.Regex or uk.gov.gchq.koryphe.impl.predicate.MultiRegex.
-See the [Predicate examples](https://gchq.github.io/gaffer-doc/getting-started/predicates/contents.html).
+See the [Predicate examples](https://gchq.github.io/gaffer-doc/v1docs/getting-started/predicates/contents.html).
 The predicate can then be used in you Operation View to filter out elements that
 don't match the regex.
 
@@ -420,4 +420,4 @@ GetElements results = new GetElements.Builder()
     .build();
 ```
 
-For more information on filtering see: [Filtering](https://gchq.github.io/gaffer-doc/getting-started/user-guide/filtering.html).
+For more information on filtering see: [Filtering](https://gchq.github.io/gaffer-doc/v1docs/getting-started/user-guide/filtering.html).

core/store/src/main/java/uk/gov/gchq/gaffer/store/schema/SchemaOptimiser.java

@@ -122,7 +122,7 @@ private void addDefaultSerialisers(final Schema schema, final Map<String, TypeDe
                 if (null == typeDef.getSerialiser()) {
                     typeDef.setSerialiser(serialisationFactory.getSerialiser(typeDef.getClazz(), isStoreOrdered, true));
                 } else if (isStoreOrdered && !typeDef.getSerialiser().preservesObjectOrdering()) {
-                    LOGGER.info("{} serialiser is used for a 'group by' property in an ordered store and it does not preserve the order of bytes. See https://gchq.github.io/gaffer-doc/getting-started/developer-guide/schemas.html#serialisers.", typeDef.getSerialiser().getClass().getName());
+                    LOGGER.info("{} serialiser is used for a 'group by' property in an ordered store and it does not preserve the order of bytes. See https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/schemas.html#serialisers.", typeDef.getSerialiser().getClass().getName());
                 }
             }
         }
@@ -180,7 +180,7 @@ private Serialiser getDefaultVertexSerialiser(final Schema schema, final boolean
             }
 
             if (isStoreOrdered && !serialiser.preservesObjectOrdering()) {
-                LOGGER.info("{} serialiser is used for vertex serialisation in an ordered store and it does not preserve the order of bytes. See https://gchq.github.io/gaffer-doc/getting-started/developer-guide/schemas.html#serialisers.",
+                LOGGER.info("{} serialiser is used for vertex serialisation in an ordered store and it does not preserve the order of bytes. See https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/schemas.html#serialisers.",
                         serialiser.getClass().getName());
             }
 

example/road-traffic/README.md

@@ -51,4 +51,4 @@ We can start with a UK region, such as the South West, and find the locations wi
 
 There will be multiple edges representing the traffic counts between the same two junctions: one for each hour of observation recorded in the data. Each of the RoadUse edges has properties attached to it representing the start of the hour during which the traffic was counted, the end of the hour, the total vehicle count for the hour and a map of vehicle type to count for the hour.
 
-There are some in-depth examples based around the Java API here: [Getting Started](https://gchq.github.io/gaffer-doc/summaries/getting-started.html).
+There are some in-depth examples based around the Java API here: [Getting Started](https://gchq.github.io/gaffer-doc/v1docs/summaries/getting-started.html).

rest-api/README.md

@@ -24,7 +24,7 @@ Each Gaffer Store then has a module where it extends the core-rest and adds in t
 
 So if you want to use the Accumulo Store REST API, you can use the accumulo-rest war.
 
-For an example of using the REST API please see the [example/road-traffic](https://gchq.github.io/gaffer-doc/components/example/road-traffic.html) module.
+For an example of using the REST API please see the [example/road-traffic](https://gchq.github.io/gaffer-doc/v1docs/components/example/road-traffic.html) module.
 
 ## How to modify the REST API for your project
 

rest-api/common-rest/src/main/java/uk/gov/gchq/gaffer/rest/SystemProperty.java

@@ -100,7 +100,7 @@ public abstract class SystemProperty {
     public static final String REST_DEBUG_DEFAULT = DebugUtil.DEBUG_DEFAULT;
     public static final String APP_TITLE_DEFAULT = "Gaffer REST";
     public static final String APP_DESCRIPTION_DEFAULT = "The Gaffer REST service.";
-    public static final String APP_DOCUMENTATION_URL_DEFAULT = "https://gchq.github.io/gaffer-doc/";
+    public static final String APP_DOCUMENTATION_URL_DEFAULT = "https://gchq.github.io/gaffer-doc/v1docs/";
     public static final String LOGO_LINK_DEFAULT = "https://github.com/gchq/Gaffer";
     public static final String LOGO_IMAGE_URL_DEFAULT = "images/logo.png";
 

store-implementation/accumulo-store/README.md

@@ -58,7 +58,7 @@ Gaffer has been extensively tested with Accumulo version 1.8.1. It is recommende
 
 Gaffer can also be used with a `MiniAccumuloCluster`. This is an Accumulo cluster that runs in one JVM. To set up a `MiniAccumuloCluster` with Gaffer support, see the [mini-accumulo-cluster](https://github.com/gchq/gaffer-tools/tree/master/mini-accumulo-cluster) project in the Gaffer tools repository.
 
-For the purposes of unit testing and small-scale examples, Gaffer offers the Store subclass [MiniAccumuloStore](https://gchq.github.io/gaffer-doc/javadoc/gaffer/uk/gov/gchq/gaffer/accumulostore/MiniAccumuloStore.html) and the `MiniAccumuloCluster` can be created using an [AccumuloTestClusterManager](https://gchq.github.io/gaffer-doc/javadoc/gaffer/uk/gov/gchq/gaffer/accumulostore/AccumuloTestClusterManager.html). This creates the local MiniAccumuloCluster if required by the properties supplied, and updates those properties with the connection details for the MiniAccumuloCluster. The cluster should be closed when finished with. 
+For the purposes of unit testing and small-scale examples, Gaffer offers the Store subclass [MiniAccumuloStore](https://gchq.github.io/gaffer-doc/v1docs/javadoc/gaffer/uk/gov/gchq/gaffer/accumulostore/MiniAccumuloStore.html) and the `MiniAccumuloCluster` can be created using an [AccumuloTestClusterManager](https://gchq.github.io/gaffer-doc/v1docs/javadoc/gaffer/uk/gov/gchq/gaffer/accumulostore/AccumuloTestClusterManager.html). This creates the local MiniAccumuloCluster if required by the properties supplied, and updates those properties with the connection details for the MiniAccumuloCluster. The cluster should be closed when finished with. 
 
 All real applications of Gaffer's `AccumuloStore` will use an Accumulo cluster running on a real Hadoop cluster consisting of multiple servers. Instructions on setting up an Accumulo cluster can be found in [Accumulo's User Manual](http://accumulo.apache.org/1.8/accumulo_user_manual).
 
@@ -101,7 +101,7 @@ Other properties can be specified in this file. For details see [Advanced Proper
 Schema
 -----------------------------------------------
 
-See [Getting Started](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/schemas.html) for details of how to write a schema that tells Gaffer what data will be stored, and how to aggregate it. Once the schema has been created, a `Graph` object can be created using:
+See [Getting Started](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/schemas.html) for details of how to write a schema that tells Gaffer what data will be stored, and how to aggregate it. Once the schema has been created, a `Graph` object can be created using:
 
 ```java
 Graph graph = new Graph.Builder()
@@ -184,12 +184,12 @@ Note that here `elements` could be a never-ending stream of `Element`s and the a
 To ingest data via bulk import, a MapReduce job is used to convert your data into files of Accumulo key-value pairs that are pre-sorted to match the distribution of data in Accumulo. Once these files are created, Accumulo moves them from their current location in HDFS to the correct directory within Accumulo's data directory. The data in them is then available for query immediately.
 
 Gaffer provides code to make this as simple as possible. The `AddElementsFromHdfs` operation is used to bulk import data.
-See [AddElementsFromHdfs](https://gchq.github.io/gaffer-doc/getting-started/operations/addelementsfromhdfs.html).
+See [AddElementsFromHdfs](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/addelementsfromhdfs.html).
 
 Queries
 -----------------------------------------------
 
-The Accumulo store supports all the standard queries. See [Operations](https://gchq.github.io/gaffer-doc/getting-started/operations/contents.html) for more details.
+The Accumulo store supports all the standard queries. See [Operations](https://gchq.github.io/gaffer-doc/v1docs/getting-started/operations/contents.html) for more details.
 
 Visibility
 -----------------------------------------------
@@ -198,7 +198,7 @@ Gaffer can take advantage of Accumulo's built-in fine-grained security to ensure
 
 If no "visibilityProperty" is specified then the column visibility is empty which means that anyone who has read access to the table can view it.
 
-See [the visibility walkthrough](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/visibilities.html) in the [Dev Guide](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/contents.html) guide for an example of how properties can be aggregated over different visibilities at query time.
+See [the visibility walkthrough](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/visibilities.html) in the [Dev Guide](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/contents.html) guide for an example of how properties can be aggregated over different visibilities at query time.
 
 Timestamp
 -----------------------------------------------

store-implementation/accumulo-store/sample-files/store.properties.sample

@@ -30,8 +30,8 @@
 #
 #   This sample file contains example settings and an explanations of which of the Accumulo deployment scenarios the settings are applicable to.
 #   For further details on properties gaffer store properties files see:
-#   https://gchq.github.io/gaffer-doc/stores/accumulo-store.html#properties-file
-#   https://gchq.github.io/gaffer-doc/stores/accumulo-store.html#advanced-properties
+#   https://gchq.github.io/gaffer-doc/v1docs/stores/accumulo-store.html#properties-file
+#   https://gchq.github.io/gaffer-doc/v1docs/stores/accumulo-store.html#advanced-properties
 
 ################################################################################
 # generic store property - gaffer.store.class

store-implementation/federated-store/README.md

@@ -21,4 +21,4 @@ This store is experimental, the API is unstable and may require breaking changes
 The `FederatedStore` is simply a Gaffer store which forwards operations to a
 collection of sub-graphs and returns a single response as though it was a single graph.
 
-Please see [FederatedStore Walkthrough](https://gchq.github.io/gaffer-doc/getting-started/developer-guide/federatedstore.html) for more details on how to set up and use this store.
+Please see [FederatedStore Walkthrough](https://gchq.github.io/gaffer-doc/v1docs/getting-started/developer-guide/federatedstore.html) for more details on how to set up and use this store.