From 972bbedb87673fc2d04bf7028a76737647b86e14 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A2u=20Cao?= <raucao@noreply.kosmos.org>
Date: Fri, 16 Aug 2019 09:26:00 +0000
Subject: [PATCH] Improve customizations documentation (#35)

---
 README.md                   | 19 +------------------
 doc/customizations-image.md | 20 ++++++++++++++++++++
 2 files changed, 21 insertions(+), 18 deletions(-)
 create mode 100644 doc/customizations-image.md

diff --git a/README.md b/README.md
index 90d1862..5c812f5 100644
--- a/README.md
+++ b/README.md
@@ -6,21 +6,4 @@ issues](https://gitea.kosmos.org/kosmos/gitea.kosmos.org/issues) for questions,
 suggestions, bugs, to-do items, and whatever else you want to discuss or
 resolve.
 
-## Building & deploying
-
-To create a new image containing the customizations:
-
-Edit `packer/custom.json` to increment the tag, then run this script (needs
-[Packer](https://www.packer.io/) in your path)
-
-
-    ./script/build_customizations_image
-
-
-Then edit `kubernetes/gitea-server.yaml` to use the new tag
-(`image: eu.gcr.io/fluted-magpie-218106/gitea_custom:$VERSION`) and apply the
-change:
-
-
-    cd kubernetes
-    kubectl apply -f gitea-server.yaml
+See `doc/` folder for some technical info.
diff --git a/doc/customizations-image.md b/doc/customizations-image.md
new file mode 100644
index 0000000..180433c
--- /dev/null
+++ b/doc/customizations-image.md
@@ -0,0 +1,20 @@
+## Customizations image
+
+### Build
+
+To create a new Docker image containing our Gitea customizations (label sets,
+styles, page content, etc.):
+
+Edit `packer/custom.json` to increment the tag, then run this script (needs
+[Packer](https://www.packer.io/) in your path)
+
+    ./script/build_customizations_image
+
+### Deploy
+
+Edit `kubernetes/gitea-server.yaml` to use the new tag
+(`image: eu.gcr.io/fluted-magpie-218106/gitea_custom:$VERSION`) and apply the
+change:
+
+    cd kubernetes
+    kubectl apply -f gitea-server.yaml