From e43de811646e15c208b44c94fa81eb90db28695c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?=
 <charles.edouard@nirmata.com>
Date: Wed, 6 Nov 2024 23:32:29 +0100
Subject: [PATCH] docs: add quick start section
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
---
 website/docs/overrides/home.html    | 4 ++--
 website/docs/quick-start/index.md   | 9 +++++++++
 website/docs/quick-start/install.md | 3 +++
 website/mkdocs.yaml                 | 5 ++++-
 4 files changed, 18 insertions(+), 3 deletions(-)
 create mode 100644 website/docs/quick-start/index.md
 create mode 100644 website/docs/quick-start/install.md

diff --git a/website/docs/overrides/home.html b/website/docs/overrides/home.html
index 2da721e..b2e7658 100644
--- a/website/docs/overrides/home.html
+++ b/website/docs/overrides/home.html
@@ -201,8 +201,8 @@
 				style="display: flex; flex-direction: column; justify-content: center; min-height: inherit;">
 				<div style="display: flex; justify-content: space-between; align-items: center;">
 					<div>
-						<h1>Kyverno Envoy plugin</h1>
-						<h2><a href="https://kyverno.io">Kyverno</a> policy based authz... in a mesh !</h2>
+						<h1><a href="https://kyverno.io">Kyverno</a> Envoy plugin</h1>
+						<h2>Policy based authorizations... in a mesh !</h2>
 						<a href="{{ page.next_page.url | url }}" title="{{ page.next_page.title | striptags }}"
 							class="md-button md-button--primary">
 							Get started
diff --git a/website/docs/quick-start/index.md b/website/docs/quick-start/index.md
new file mode 100644
index 0000000..577b149
--- /dev/null
+++ b/website/docs/quick-start/index.md
@@ -0,0 +1,9 @@
+# Quick start
+
+TODO
+
+## How to use it?
+
+Chainsaw is built with CI tools in mind - you only really need to download and execute it in your build script.
+
+However, [installing it on your local machine](./install.md) is entirely possible.
diff --git a/website/docs/quick-start/install.md b/website/docs/quick-start/install.md
new file mode 100644
index 0000000..7cd4222
--- /dev/null
+++ b/website/docs/quick-start/install.md
@@ -0,0 +1,3 @@
+# Installation
+
+TODO
diff --git a/website/mkdocs.yaml b/website/mkdocs.yaml
index 3b087ef..e1378d2 100644
--- a/website/mkdocs.yaml
+++ b/website/mkdocs.yaml
@@ -2,6 +2,9 @@ INHERIT: ./mkdocs.base.yaml
 
 nav:
 - Home: index.md
+- Quick start:
+  - quick-start/index.md
+  - quick-start/install.md
 - Documentation:
   - intro.md
   - quick-start.md
@@ -16,12 +19,12 @@ nav:
   - tutorials/standalone-envoy.md
   - tutorials/istio.md
   - tutorials/mtls-istio.md
+- Performance: performance.md
 - Reference:
   - reference/index.md
   - reference/json-schemas.md
   - APIs:
     - v1alpha1: reference/apis/policy.v1alpha1.md
-- Performance: performance.md
 - Community:
   - community/index.md
   - Contributing: community/contribute.md