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 @@

- +

@@ -196,7 +196,7 @@

- Developers Guide + Developer Guide

Useful information for developers of Gaffer and general project architecture.

 diff --git a/docs/user-guide/introduction.md b/docs/user-guide/introduction.md index 6d9d3bab87..1a7fe17d10 100644 --- a/docs/user-guide/introduction.md +++ b/docs/user-guide/introduction.md @@ -4,12 +4,16 @@ Welcome to the Gaffer user guide. The pages under this section are intended to help a user of Gaffer understand the core concepts and quickly get started querying a currently deployed graph. +## The Basics + If you are brand new to Gaffer and graph databases in general, the Gaffer basics pages contain useful information to give an overview and foundation. - [What is Graph?](./gaffer-basics/what-is-a-graph.md) - [What is Gaffer?](./gaffer-basics/what-is-gaffer.md) +## Available APIs + Gaffer comes with a few different APIs, the pages in the user guide give an introduction to these APIs and how to use them to query a graph. Also included is an introduction to some of the core languages used for the APIs. @@ -20,6 +24,8 @@ is an introduction to some of the core languages used for the APIs. - [Python API (gafferpy)](./apis/python-api.md) - [Java API](./apis/java-api.md) +## Graph Querying + To query a graph Gaffer uses a custom querying format based around isolated functions called `Operations`. This user guide gives an introduction to this format and provides examples to help users formulate their own. diff --git a/mkdocs.yml b/mkdocs.yml index 2c916d9221..9f139330aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -96,7 +96,7 @@ nav: - Apache Gremlin: - 'Gremlin Support in Gaffer': 'user-guide/query/gremlin/gremlin.md' - 'Graph Schemas': 'user-guide/schema.md' - - Developers Guide: + - Developer Guide: - 'Introduction': 'development-guide/introduction.md' - 'Example Deployment': - 'Project Setup': 'development-guide/example-deployment/project-setup.md'