From 3a0dc813cc9db118e4593e849b4978b38bb84a48 Mon Sep 17 00:00:00 2001 From: cn337131 <141730190+cn337131@users.noreply.github.com> Date: Wed, 16 Aug 2023 14:09:53 +0000 Subject: [PATCH] fix typo and add overview of guides --- docs/dev/docker.md | 2 +- docs/dev/kubernetes-guide/kubernetes.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/dev/docker.md b/docs/dev/docker.md index 6a8c39cea7..dc20fca237 100644 --- a/docs/dev/docker.md +++ b/docs/dev/docker.md @@ -16,7 +16,7 @@ In this directory you can find the Dockerfiles and docker compose files for buil - [Gaffer's JupyterHub Options Server](https://github.com/gchq/gaffer-docker/tree/develop/docker/gaffer-jhub-options-server) - [Spark](https://github.com/gchq/gaffer-docker/tree/develop/docker/spark-py) -Each directory contains a README with more specific information on what these imates are for and how to build them. +Each directory contains a README with more specific information on what these images are for and how to build them. Please note that some of these containers will only be useful if utilised by the Helm Charts under Kubernetes, and may not be possible to run on their own. diff --git a/docs/dev/kubernetes-guide/kubernetes.md b/docs/dev/kubernetes-guide/kubernetes.md index 9c9f98cbf9..59c1bda53e 100644 --- a/docs/dev/kubernetes-guide/kubernetes.md +++ b/docs/dev/kubernetes-guide/kubernetes.md @@ -27,3 +27,7 @@ To add the gaffer-docker repo to helm run: ```bash helm repo add gaffer-docker https://gchq.github.io/gaffer-docker ``` + +## How to Guides + +Within this documentation there are also a number of guides to help you deploy Gaffer on Kubernetes. It is important you look at these before you get started as they provide the initial steps for running these applications.