diff --git a/docs/administration-guide/introduction.md b/docs/administration-guide/introduction.md index e69de29bb2..e6087ec6ba 100644 --- a/docs/administration-guide/introduction.md +++ b/docs/administration-guide/introduction.md @@ -0,0 +1,34 @@ +# Administration Guide + +This guide is intended for more administrators of a Gaffer deployment and more +advanced users. It is recommended to read the [user guide](../user-guide/introduction.md) +and be familiar with Gaffer beforehand as many of the core concepts are +expanded on and covered in more detail. + +## How to Run Gaffer? + +There are detailed guides in this section on how to set up a Gaffer instance, +covering both containerised deployments via standard Docker/Podman along with +Kubernetes deployment via Helm. + +- [Kubernetes Guide](./where-to-run-gaffer/kubernetes-guide/kubernetes-guide.md) +- [Docker Guide](./where-to-run-gaffer/gaffer-docker.md) + +## Graph Configuration + +There are many aspects of a Gaffer graph deployment that can be configured. +If you wish to know how and what can be configured along with a more in-depth +guide of Gaffers schemas you can see the section on configuring a graph. + +- [Configuration Overview](./gaffer-config/config.md) + +## Gaffer Stores + +The store selection for the Gaffer backend is also covered in this guide to +provide an overview of the different types and features each provides. + +- [Store Guide](./gaffer-stores/store-guide.md) +- [Map Store](./gaffer-stores/map-store.md) +- [Accumulo Store](./gaffer-stores/accumulo-store.md) +- [Proxy Store](./gaffer-stores/proxy-store.md) +- [Federated Store](./gaffer-stores/federated-store.md) diff --git a/docs/development-guide/introduction.md b/docs/development-guide/introduction.md index f9d9dae2c8..cabdb8e8cb 100644 --- a/docs/development-guide/introduction.md +++ b/docs/development-guide/introduction.md @@ -1,4 +1,4 @@ -# Development +# Developer Guide This development guide will take you through the steps required to start development work with Gaffer. This guide is not for end users of Gaffer and is instead targeted at those who wish to develop Gaffer or build Gaffer extensions. @@ -12,10 +12,10 @@ Organization](https://github.com/orgs/gchq/repositories). ## Repositories -The [Gaffer core repo](https://github.com/gchq/Gaffer) contains the main Gaffer product. +The [Gaffer core repo](https://github.com/gchq/Gaffer) contains the main Gaffer product. If you are completely new to Gaffer you can try out our [Road Traffic Demo](https://github.com/gchq/Gaffer/blob/master/example/road-traffic/README.md) or look at our example [deployment guide](../development-guide/example-deployment/project-setup.md). -The [gaffer-tools repo](https://github.com/gchq/gaffer-tools) contains a number of useful tools that assist in working with Gaffer. +The [gaffer-tools repo](https://github.com/gchq/gaffer-tools) contains a number of useful tools that assist in working with Gaffer. These include: - `gafferpy` - Allows operations against a graph to be executed from a Python shell @@ -23,11 +23,11 @@ These include: - `performance-testing` - Methods of testing the performance of ingest and query operations against a graph - `random-element-generation` - Code to generate large volumes of random graph data -The [Gaffer docker repo](https://github.com/gchq/gaffer-docker) contains the code needed to run Gaffer using Docker or Kubernetes. +The [Gaffer docker repo](https://github.com/gchq/gaffer-docker) contains the code needed to run Gaffer using Docker or Kubernetes. More information about running a containerised instance of Gaffer can be found in our [adminstration guide](../administration-guide/introduction.md). It is also worth noting the [koryphe repo](https://github.com/gchq/koryphe) as this is a key dependency for Gaffer. -It contains an extensible functions library for filtering, aggregating and transforming data based on the Java Function API. +It contains an extensible functions library for filtering, aggregating and transforming data based on the Java Function API. ## Building Gaffer diff --git a/docs/home_page_override/home.html b/docs/home_page_override/home.html index 3b1f8afc33..e225e36e94 100644 --- a/docs/home_page_override/home.html +++ b/docs/home_page_override/home.html @@ -188,7 +188,7 @@