From 4cc93bf234fb52ebeab758e8acc781bc11d82c86 Mon Sep 17 00:00:00 2001
From: Derek <103802618+leeederek@users.noreply.github.com>
Date: Fri, 13 Oct 2023 15:08:31 -0400
Subject: [PATCH] docs: add docs about kurtosis gateway (#1558)

## Description:
This pull request adds docs for the `kurtosis gateway` command - a
previously undocumented command necessary for interaction with
kurtosis-on-k8s set ups.

## Is this change user facing?
YES

## References (if applicable):
---
 docs/docs/cli-reference/gateway.md | 11 +++++++++++
 docs/docs/guides/running-in-k8s.md |  4 ++--
 2 files changed, 13 insertions(+), 2 deletions(-)
 create mode 100644 docs/docs/cli-reference/gateway.md

diff --git a/docs/docs/cli-reference/gateway.md b/docs/docs/cli-reference/gateway.md
new file mode 100644
index 0000000000..6feead84ff
--- /dev/null
+++ b/docs/docs/cli-reference/gateway.md
@@ -0,0 +1,11 @@
+---
+title: gateway
+sidebar_label: gateway
+slug: /gateway
+---
+
+The Kurtosis gateway command is exclusively for use with Kubernetes backends and is intended to be a command you invoke before interacting with a remote Kurtosis engine deployed on a Kubernetes clsuter. Assuming you have configured your `kurtosis-config.yml` file to work with your Kubernetes cluster [guide here](../guides/running-in-k8s.md), then this command will start a local "gateway" to connect your local machine to your remote Kubernetes cluster, enabling you to interact with the remote Kurtosis engine that lives on that cluster. 
+
+```console
+kurtosis gateway
+```
\ No newline at end of file
diff --git a/docs/docs/guides/running-in-k8s.md b/docs/docs/guides/running-in-k8s.md
index d4e924c063..87d6d774d6 100644
--- a/docs/docs/guides/running-in-k8s.md
+++ b/docs/docs/guides/running-in-k8s.md
@@ -65,8 +65,8 @@ kurtosis-clusters:
 IV. Configure Kurtosis
 --------------------------------
 
-1. Run `kurtosis cluster set cloud`.  This will start the engine remotely. 
-1. *In another terminal*, run `kurtosis gateway`. This will act as a middle man between your computer's ports and your services deployed on Kubernetes ports and has to stay running as a separate proccess.
+1. Run `kurtosis cluster set cloud`.  This will start the engine remotely. See the CLI reference for more information about `kurtosis cluster` commands [here](../cli-reference/cluster-set.md).
+1. *In another terminal*, run [`kurtosis gateway`](../cli-reference/gateway.md). This will act as a middle man between your computer's ports and your services deployed on Kubernetes ports and has to stay running as a separate proccess.
 
 Done! Now you can run any Kurtosis command or package just like if you were doing it locally.