From 2adb756cbc44254e4200e92bd67a112aaa953b81 Mon Sep 17 00:00:00 2001
From: "R. Tyler Croy" <rtyler@brokenco.de>
Date: Thu, 26 Nov 2020 21:22:25 -0800
Subject: [PATCH] Start adding some docs for writing steps, only cache covered
 now

---
 docs/Writing_Steps.adoc | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 docs/Writing_Steps.adoc

diff --git a/docs/Writing_Steps.adoc b/docs/Writing_Steps.adoc
new file mode 100644
index 0000000..73633e3
--- /dev/null
+++ b/docs/Writing_Steps.adoc
@@ -0,0 +1,21 @@
+= Writing steps for Otto
+
+
+
+== Caching
+
+If the manifest contains `cache: true`, the agent will create a cache directory
+for this step to be used by all invocations. The location of the step's caching
+directory will be available in the invocation file:
+
+.Example invocation file snippet for the `git` step
+[source,yaml]
+----
+configuration:
+  cache: '/home/otto/caches/git'
+parameters:
+----
+
+The location of this caching directory should **not** be treated as
+deterministic, and can change at any time. Steps should always rely on the
+`cache` key in the invocation file's `configuration` block.