Gh-505: Fix broken links and enforce link checks (#506)

* Enable warnings for link validation and strict mode * Fix around 20 instances of broken links
gchq · Jun 7, 2024 · aa5533a · aa5533a
1 parent 21a7fa6
commit aa5533a
Show file tree

Hide file tree

Showing 17 changed files with 30 additions and 24 deletions.
diff --git a/docs/administration-guide/gaffer-stores/federated-store.md b/docs/administration-guide/gaffer-stores/federated-store.md
@@ -147,7 +147,7 @@ To add a graph to a Federated Store you use the `AddGraph` operation. To add a g
 
 A Schema & Properties are not required if `parentSchemaId`/`parentPropertiesId` are instead used to retrieve this information from a Graph Library.
 
-You can limit user access when adding sub-graphs, see [Limiting Access](#limit-access-with-authentication).
+You can limit user access when adding sub-graphs, see [Restricting Graph Access](#restricting-graph-access).
 User specified store properties are allowed by default, but this can be disallowed if desired, see [limit custom properties](#limit-custom-properties).
 
 ```json title="AddGraph Operation"

diff --git a/docs/administration-guide/gaffer-stores/store-guide.md b/docs/administration-guide/gaffer-stores/store-guide.md
@@ -108,7 +108,7 @@ You could also set the default cache suffix to share everything and set a specif
 
 Some operations are not available by default and you will need to manually configure them.
 
-These customisable operations can be added to your Gaffer graph by providing config in one or more [operation declaration JSON files](../gaffer-config/config.md#operationsdeclarationsjson).
+These customisable operations can be added to your Gaffer graph by providing config in one or more [operation declaration JSON files](../gaffer-config/config.md#operations-declarations-json).
 
 ### Named Operations
 Named Operations depends on the Cache service being active at runtime. See [Caches](#caches) above for how to enable these.

diff --git a/docs/administration-guide/job-tracker.md b/docs/administration-guide/job-tracker.md
@@ -14,7 +14,7 @@ while a 'cache' is used to store any job results.
 ## Configuration
 
 By default, the job tracker is disabled. 
-It can be enabled by setting its associated [store property](../administration-guide/gaffer-stores/store-guide#store-properties) to true.
+It can be enabled by setting its associated [store property](../administration-guide/gaffer-stores/store-guide.md#store-properties) to true.
 There must also be a [cache configured](../administration-guide/gaffer-stores/store-guide.md#caches) for the job
 tracker to work.
 
@@ -26,7 +26,7 @@ Note that this is not the same as your initial cache, as this results 'cache' is
 which will store your results.
 
 To store results using the job tracker a few elements must be set up. 
-Firstly, you need to add two operations to an [operations declarations JSON file](../administration-guide/gaffer-config/config.md#operationsdeclarationsjson). 
+Firstly, you need to add two operations to an [operations declarations JSON file](../administration-guide/gaffer-config/config.md#operations-declarations-json).
 These operations are [`ExportToGafferResultCache` and `GetGafferResultCacheExport`](../reference/operations-guide/export.md#exporttogafferresultcache).
 Together these allow you to store your results in a seperate Gaffer graph, your 'cache'.
 

diff --git a/docs/change-notes/migrating-from-v1-to-v2/deprecations.md b/docs/change-notes/migrating-from-v1-to-v2/deprecations.md
@@ -2,7 +2,7 @@
 
 This page describes deprecated code which has been removed in Gaffer 2 and how to migrate to better equivalents. Each heading for a section below refers to a classname from `uk.gov.gchq.gaffer` where there have been changes or where that class has been removed entirely. The section headings link to the code on GitHub for that class (as of the Gaffer 1.21.1 release).
 
-Deprecations impacting the serialisers used in schemas are listed first, followed by [changes to Seed Matching and changes to Traits](#changes-to-seed-matching-and-traits). Other deprecations are then [listed in alphabetical order](#all-other-deprecations).
+Deprecations impacting the serialisers used in schemas are listed first, followed by [changes to Seed Matching](#removal-of-seed-matching) and [changes to Traits](#changes-to-store-traits). Other deprecations are then [listed in alphabetical order](#all-other-deprecations).
 
 ## Serialisers
 

diff --git a/docs/development-guide/example-deployment/project-setup.md b/docs/development-guide/example-deployment/project-setup.md
@@ -137,7 +137,7 @@ mounted into the container for them to be included in the deployment which is co
 
 This is probably the simplest configuration file in the Gaffer deployment. In the example that follows
 we use it to set the file location properties of where the other config files are (inside the
-container). See [Graph Configuration](../../administration-guide/gaffer-config/config.md#applicationproperties)
+container). See [Graph Configuration](../../administration-guide/gaffer-config/config.md#application-properties)
 for more details on this configuration file.
 
 ```properties title="application.properties"

diff --git a/docs/development-guide/project-structure/components/cache.md b/docs/development-guide/project-structure/components/cache.md
@@ -7,7 +7,7 @@ CacheServiceLoader.getService();
 ```
 
 By default, there is no service loaded so if you're using a component that makes use of the `CacheServiceLoader`, be sure to specify the service class in the `store.properties` file.
-See the [Stores reference guide](../../../administration-guide/gaffer-stores/store-guide.md#cache-configuration) for configuration info.
+See the [Stores reference guide](../../../administration-guide/gaffer-stores/store-guide.md#cache-service) for configuration info.
 
 If using an external cache service (anything found in the cache library) be sure to include the library as a dependency:
 ```xml

diff --git a/docs/development-guide/project-structure/components/operation.md b/docs/development-guide/project-structure/components/operation.md
@@ -72,7 +72,7 @@ public static class Builder extends Operation.BaseBuilder<GetElements, Builder>
 ### Operation Scores
 
 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](/docs/reference/stores-guide/stores.md#scoreoperationchain) and [ScoreOperationChainExample](../../../reference/operations-guide/misc.md#scoreoperationchain).
+There is a `DefaultScoreResolver` to which the custom implementation should delegate, in a manner specific to the new Operation. For more info, see [ScoreOperationChain](../../../administration-guide/gaffer-stores/store-guide.md#scoreoperationchain) and [ScoreOperationChainExample](../../../reference/operations-guide/misc.md#scoreoperationchain).
 
 ### Documentation
 

diff --git a/docs/development-guide/project-structure/components/user.md b/docs/development-guide/project-structure/components/user.md
@@ -24,7 +24,7 @@ do not have access to the cluster and by only allowing users to connect to Gaffe
 `User` object is constructed via a [`UserFactory`](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/rest/factory/UserFactory.html).
 Currently, we only provide one implementation of this, the [`UnknownUserFactory`](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/rest/factory/UnknownUserFactory.html)
 This `UnknownUserFactory` will always just return `new User()` - it is used as the default user factory. To specify the
-user factory class define the `gaffer.user.factory.class` [REST property](../../../administration-guide/gaffer-config/config.md#applicationproperties).
+user factory class define the `gaffer.user.factory.class` [REST property](../../../administration-guide/gaffer-config/config.md#application-properties).
 
 To authenticate your users, you will need to extend the REST API to add your chosen authentication mechanism. You will
 need to implement your own `UserFactory` class which creates a new `User` instance based on the user making the REST

diff --git a/docs/development-guide/rest-api-sketches.md b/docs/development-guide/rest-api-sketches.md
@@ -5,7 +5,7 @@ use cardinality, see the [cardinality](../user-guide/gaffer-basics/what-is-cardi
 
 ## Sketches Library
 
-To learn more about the Sketches library see [advanced properties](../../reference/properties-guide/advanced) reference page. 
+To learn more about the Sketches library see [advanced properties](../reference/properties-guide/advanced.md) reference page. 
 The sketches library is included by default with the Map and Accumulo stores. This is because the `sketches-library` is a dependency in each of
 the respective store modules' poms. As well as this, the serialisation is handled by the fact the 
 [SketchesJsonModules](https://github.com/gchq/Gaffer/blob/gaffer2-2.0.0/library/sketches-library/src/main/java/uk/gov/gchq/gaffer/sketches/serialisation/json/SketchesJsonModules.java) 

diff --git a/docs/reference/functions-guide/functions.md b/docs/reference/functions-guide/functions.md
@@ -56,7 +56,7 @@ Function | Origin
 [`impl.function.ParseTime`](koryphe-functions.md#parsetime) | Koryphe
 [`impl.function.ReverseString`](koryphe-functions.md#reversestring) | Koryphe
 [`impl.function.SetValue`](koryphe-functions.md#setvalue) | Koryphe
-[`impl.function.Size`](koryphe-functions.md#size) | Koryphe
+`impl.function.Size` | Koryphe
 [`impl.function.StringAppend`](koryphe-functions.md#stringappend) | Koryphe
 [`impl.function.StringJoin`](koryphe-functions.md#stringjoin) | Koryphe
 [`impl.function.StringPrepend`](koryphe-functions.md#stringprepend) | Koryphe

diff --git a/docs/reference/operations-guide/accumulo.md b/docs/reference/operations-guide/accumulo.md
@@ -19,7 +19,7 @@ graph TD
 ## GetElementsBetweenSets
 
 !!! warning "Deprecated"
-    Operation has been deprecated in favour of [`GetElementsBetweenSetPairs`](#getelementsbetweensetpairs)
+    Operation has been deprecated in favour of [`GetElementsBetweenSetPairs`](#getelementsbetweensetspairs)
 
 Gets edges that exist between 2 sets and entities in the first set. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/accumulostore/operation/impl/GetElementsBetweenSets.html)
 

diff --git a/docs/reference/operations-guide/export.md b/docs/reference/operations-guide/export.md
@@ -1317,7 +1317,7 @@ This operation exports results to a cache which is backed by a simple Gaffer gra
 
 ## GetGafferResultCacheExport
 
-Fetches data from a Gaffer result cache. Requires a cache to be [configured](../../../administration-guide/gaffer-stores/store-guide/#caches). [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/operation/impl/export/resultcache/GetGafferResultCacheExport.html)
+Fetches data from a Gaffer result cache. Requires a cache to be [configured](../../administration-guide/gaffer-stores/store-guide.md#cache-service). [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/operation/impl/export/resultcache/GetGafferResultCacheExport.html)
 
 !!! example
     See examples for ExportToGafferResultCache above for usage.

diff --git a/docs/reference/operations-guide/federated-operation.md b/docs/reference/operations-guide/federated-operation.md
@@ -51,9 +51,9 @@ configured the `storeConfiguredGraphIds` then all graphIds will be used.
 The `mergeFunction` parameter is the Function you want to use when merging the
 results from the subgraphs.  
 
-If you do not specify a `mergeFunction`,  then the admin configured
+If you do not specify a `mergeFunction`, then the admin configured
 `storeConfiguredMergeFunctions` are used, else the default `mergeFunctions` are
-used as [shown in the table below.](#default-storeconfiguredmergefunctions)
+used as [shown in the table below.](#default-store-configured-merge-functions)
 
 For example, when GetElements is used as the operation inside a
 FederatedOperation and you haven't specified a `mergeFunction`, the
@@ -750,7 +750,7 @@ is a schema conflict.
 #### ConcatenateMergeFunction
 
 This merge function is the default merge function for the majority of operations
-as seen [in the table above](#default-storeconfiguredmergefunctions). You can also
+as seen [in the table above](#default-store-configured-merge-functions). You can also
 override the default merge functions for operations like we have below. It results
 in concantinating all the results of the operations together.
 

diff --git a/docs/reference/predicates-guide/predicates.md b/docs/reference/predicates-guide/predicates.md
@@ -13,7 +13,7 @@ Predicate | Origin
 [`impl.predicate.AgeOff`](koryphe-predicates.md#ageoff) | Koryphe
 `impl.predicate.AgeOffFromDays` | Koryphe
 [`impl.predicate.And`](koryphe-predicates.md#and) | Koryphe
-[`impl.predicate.AreEqual`](koryphe-predicates#areequal) | Koryphe
+[`impl.predicate.AreEqual`](koryphe-predicates.md#areequal) | Koryphe
 [`impl.predicate.AreIn`](koryphe-predicates.md#arein) | Koryphe
 [`impl.predicate.CollectionContains`](koryphe-predicates.md#collectioncontains) | Koryphe
 [`impl.predicate.Exists`](koryphe-predicates.md#exists) | Koryphe
@@ -39,7 +39,7 @@ Predicate | Origin
 [`impl.predicate.IsXMoreThanY`](koryphe-predicates.md#isxmorethany) | Koryphe
 [`impl.predicate.MapContains`](koryphe-predicates.md#mapcontains) | Koryphe
 [`impl.predicate.MapContainsPredicate`](koryphe-predicates.md#mapcontainspredicate) | Koryphe
-[`predicate.PredicateMap`](koryphe-predicates#predicatemap) | Koryphe
+[`predicate.PredicateMap`](koryphe-predicates.md#predicatemap) | Koryphe
 `predicate.AdaptedPredicate` | Koryphe
 `predicate.PredicateComposite` | Koryphe
 [`impl.predicate.StringContains`](koryphe-predicates.md#stringcontains) | Koryphe

diff --git a/docs/user-guide/gaffer-basics/what-is-a-graph.md b/docs/user-guide/gaffer-basics/what-is-a-graph.md
@@ -37,4 +37,4 @@ Take the example below which is an extension of the previous graph, as you can s
         end
     ```
 
-For definitions on the terms used in this page please see the [glossary](/reference/glossary) page.
+For definitions on the terms used in this page please see the [glossary](../../reference/glossary.md) page.
diff --git a/docs/user-guide/query/gaffer-syntax/import-export/csv.md b/docs/user-guide/query/gaffer-syntax/import-export/csv.md
@@ -90,8 +90,8 @@ into the graph.
 2. The `GenerateElements` operation will transform each line of the file into a
    Gaffer Element. You will need to provide an element generator that is
    suitable for the file you have provided. The two `CsvElementGenerators`
-   provided in core Gaffer are [`Neo4jElementGenerator`](#neo4j-format) and
-   [`NeptuneCsvElementGenerator`](#neptune-format).
+   provided in core Gaffer are [`Neo4jElementGenerator`](#neo4j-generators) and
+   [`NeptuneCsvElementGenerator`](#neptune-generators).
 3. Finally, the stream of Gaffer Elements are added with an `AddElements`
    operation.
 
@@ -122,8 +122,8 @@ Exporting to csv is done with a similar OperationChain.
    string. You must supply a `CsvGenerator` to do this. You can build a custom
    [`CsvGenerator`](#custom-formats), or use a supplied one. The two
    `CsvGenerators` provided in core Gaffer are
-   [`Neo4jCsvGenerator`](#neo4j-format) and
-   [`NeptuneCsvGenerator`](#neptune-format).
+   [`Neo4jCsvGenerator`](#neo4j-generators) and
+   [`NeptuneCsvGenerator`](#neptune-generators).
 3. Then the `ExportToLocalFile` operation is used to save this string output
    into a local file.
 
@@ -169,7 +169,7 @@ Neptune.
     headers. All instances of `-` are replaced with `_`, and invalid characters
     are stripped as outlined in [PropertiesUtil](https://github.com/gchq/Gaffer/blob/f16de7c3eccfe7a800cad1d7eea5fbae4cf01d44/core/common-util/src/main/java/uk/gov/gchq/gaffer/commonutil/PropertiesUtil.java#L26).
 
-As shown [later in the examples](#neo4j-format), OpenCypher formats let you
+As shown [later in the examples](#neo4j-generators), OpenCypher formats let you
 dictate property types in the header, like `propertyName:type`. Below is a table
 that shows which Gaffer transform function is used to deserialise each
 [OpenCypher data

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -3,6 +3,12 @@ repo_url: https://github.com/gchq/gaffer-doc
 repo_name: gchq/gaffer-doc
 edit_uri: edit/v2docs/docs/
 copyright: <a href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/">Copyright &copy; 2016-2023 Crown Copyright</a>
+validation:
+  omitted_files: warn
+  absolute_links: warn
+  unrecognized_links: warn
+  anchors: warn
+strict: true
 markdown_extensions:
   - admonition
   - pymdownx.details
-Original file line number
+Diff line change
@@ Expand Up @@
             end
         ```
-    For definitions on the terms used in this page please see the [glossary](/reference/glossary) page.
+    For definitions on the terms used in this page please see the [glossary](../../reference/glossary.md) page.