Skip to content

Commit

Permalink
Fix relative links
Browse files Browse the repository at this point in the history
  • Loading branch information
GCHQDeveloper314 committed Aug 2, 2023
1 parent 6f489f6 commit 3aa2d0e
Show file tree
Hide file tree
Showing 10 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/dev/components/accumulo-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The [accumulo-store module](https://github.com/gchq/Gaffer/tree/master/core/store) is an implementation of the Store API which uses Apache Accumulo.

This page contains brief details on the internal implementation of the `AccumuloStore`. For information on configuring and using this store, see [the Accumulo Store reference page](../reference/stores-guide/accumulo.md).
This page contains brief details on the internal implementation of the `AccumuloStore`. For information on configuring and using this store, see [the Accumulo Store reference page](../../reference/stores-guide/accumulo.md).

## Introduction

Expand All @@ -21,7 +21,7 @@ The core of the functionality is implemented in the key-packages, the iterators

## Key-packages

As noted in the [Key-packages section of the Accumulo Store reference](../reference/stores-guide/accumulo.md#key-packages), key-packages are responsible for converting `Element`s to and from key-value pairs, for creating ranges of keys containing all data relevant to a particular query, and for configuring the Iterators. Gaffer provides two key-packages: `ByteEntityKeyPackage` and `ClassicKeyPackage`. Advanced users are able to create their own key-packages if they wish - see [options for future key-packages](#options-for-future-key-packages) for some ideas.
As noted in the [Key-packages section of the Accumulo Store reference](../../reference/stores-guide/accumulo.md#key-packages), key-packages are responsible for converting `Element`s to and from key-value pairs, for creating ranges of keys containing all data relevant to a particular query, and for configuring the Iterators. Gaffer provides two key-packages: `ByteEntityKeyPackage` and `ClassicKeyPackage`. Advanced users are able to create their own key-packages if they wish - see [options for future key-packages](#options-for-future-key-packages) for some ideas.

Before these key-packages are described, we review the main design goals:

Expand Down
4 changes: 2 additions & 2 deletions docs/dev/components/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](../reference/stores-guide/stores.md#cache-configuration) for configuration info.
See the [Stores reference guide](../../reference/stores-guide/stores.md#cache-configuration) for configuration info.

If using an external cache service (anything found in the cache library) be sure to include the library as a dependency:
```
Expand All @@ -21,4 +21,4 @@ If using an external cache service (anything found in the cache library) be sure
When run in a servlet context, the `CacheServiceLoader` should be shutdown gracefully by the `ServletLifecycleListener` found in the REST package. Do not trust the shutdown hook in a servlet context.
If running outside a servlet environment, you can either call shutdown on the cache service manually or use the shutdown hook upon initialisation of the cache service loader.

For information on Gaffer caches and cache configuration, see [the cache section of the Stores Guide](../reference/stores-guide/stores.md#caches).
For information on Gaffer caches and cache configuration, see [the cache section of the Stores Guide](../../reference/stores-guide/stores.md#caches).
2 changes: 1 addition & 1 deletion docs/dev/components/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It also contains the logic for processing these `Element`s - `ElementAggregator`

Gaffer makes use of Java 8's Function and Predicate interfaces to aggregate, transform and filter data. To allow these Function and Predicate classes to process tuples we make use of the [Koryphe](https://github.com/gchq/koryphe/tree/master) library. Koryphe allows us to wrap the Gaffer Elements in a tuple and pass it any Function or Predicate.

You can use any of our implementations ([see reference pages](../reference/intro.md)) or write your own.
You can use any of our implementations ([see reference pages](../../reference/intro.md)) or write your own.

All the following classes will act on one or more Element identifiers (vertex/source/destination/directed) or properties. If you implement the Java 8 interfaces directly, you would need to add the following `JsonType` annotation to your class:

Expand Down
2 changes: 1 addition & 1 deletion docs/dev/components/graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ But, essentially a graph requires just 3 things: some store properties, a schema
See the [Graph Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/graph/package-summary.html) for further documentation.

## Store Properties
The store properties tells the graph the type of store to connect to along with any required connection details. See the [Stores](../reference/stores-guide/stores.md) reference page for more information on the different Stores for Gaffer.
The store properties tells the graph the type of store to connect to along with any required connection details. See the [Stores](../../reference/stores-guide/stores.md) reference page 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/v1docs/getting-started/developer-guide/schemas.html) for more information - v1 docs, to be updated and added to this documentation in future.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/components/libraries/flink.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In order to make use of the flink libraries you will need to include this librar
</dependency>
```

For information on registering and using flink operations, see the [Flink Operations guide](../../reference/operations-guide/flink.md).
For information on registering and using flink operations, see the [Flink Operations guide](../../../reference/operations-guide/flink.md).

## I am getting errors when running the Flink operations on a cluster
This could be to do with the way the Gaffer Store class is serialised and distributed around the cluster. To distribute the job, Flink requires all of the components of the job to be Serializable.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/components/libraries/sketches.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ In order to make use of the sketches libraries you will need to include this lib
</dependency>
```

For information on configuring and using sketches, see the [Cardinality guide](../../getting-started/guide/cardinality.md#how-to-add-cardinality-to-your-graph) (for configuring `SketchesJsonModules` expand "Additional config").
For information on configuring and using sketches, see the [Cardinality guide](../../../getting-started/guide/cardinality.md#how-to-add-cardinality-to-your-graph) (for configuring `SketchesJsonModules` expand "Additional config").
2 changes: 1 addition & 1 deletion docs/dev/components/libraries/spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ To use spark with Accumulo you will need to include this dependency:
</dependency>
```

For information on registering and using spark operations, see the [Spark Operations guide](../../reference/operations-guide/spark.md).
For information on registering and using spark operations, see the [Spark Operations guide](../../../reference/operations-guide/spark.md).
2 changes: 1 addition & 1 deletion docs/dev/components/operation.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,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](../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](/docs/reference/stores-guide/stores.md#scoreoperationchain) and [ScoreOperationChainExample](../../reference/operations-guide/misc.md#scoreoperationchain).

### Documentation

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/stores-guide/accumulo.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ In Gaffer's `AccumuloStore` a key-package contains all the logic for:

A key-package is an implementation of the `AccumuloKeyPackage` interface. Gaffer provides two implementations: `ByteEntityKeyPackage` and `ClassicKeyPackage`. These names are essentially meaningless. The "classic" in `ClassicKeyPackage` refers to the fact that it is similar to the implementation in the first version of Gaffer (known as "Gaffer1").

Both key-packages should provide good performance for most use-cases. There will be slight differences in performance between the two for different types of query. The `ByteEntityKeyPackage` will be slightly faster if the query specifies that only out-going or in-coming edges are required. The `ClassicKeyPackage` will be faster when querying for all edges involving a pair of vertices. See the Key-Packages part of the [Accumulo Store Implementation page](../../dev/accumulo-store.md) for more information about these key-packages.
Both key-packages should provide good performance for most use-cases. There will be slight differences in performance between the two for different types of query. The `ByteEntityKeyPackage` will be slightly faster if the query specifies that only out-going or in-coming edges are required. The `ClassicKeyPackage` will be faster when querying for all edges involving a pair of vertices. See the Key-Packages part of the [Accumulo Store Implementation page](../../dev/components/accumulo-store.md) for more information about these key-packages.

## Advanced properties

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/stores-guide/stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Gaffer comes with three cache implementations:

The `HashMap` cache is not persistent. If using the Hazelcast instance of the Cache service be aware that once the last node shuts down, all data will be lost. This is due to the data being held in memory in a distributed system.

For information on implementing caches, see [the cache developer docs page](../../dev/cache.md).
For information on implementing caches, see [the cache developer docs page](../../dev/components/cache.md).

### Cache configuration

Expand Down

0 comments on commit 3aa2d0e

Please sign in to comment.