Skip to content

Commit

Permalink
docs: add quick start section
Browse files Browse the repository at this point in the history
Signed-off-by: Charles-Edouard Brétéché <charles.edouard@nirmata.com>
  • Loading branch information
eddycharly committed Nov 7, 2024
1 parent dd31f6f commit e43de81
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
4 changes: 2 additions & 2 deletions website/docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
9 changes: 9 additions & 0 deletions website/docs/quick-start/index.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions website/docs/quick-start/install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Installation

TODO
5 changes: 4 additions & 1 deletion website/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit e43de81

Please sign in to comment.