Provide initial implementation of cheatsheet concept

Signed-off-by: lucperkins <lucperkins@gmail.com>
falcosecurity · Jul 23, 2019 · 61210c2 · 61210c2
1 parent 8b85669
commit 61210c2
Show file tree

Hide file tree

Showing 8 changed files with 64 additions and 0 deletions.
diff --git a/content/cheatsheet/forbidden-thing.yaml b/content/cheatsheet/forbidden-thing.yaml
@@ -0,0 +1,3 @@
+- rule: forbid_something
+  desc: This thing shouldn't happen
+  condition: not thing in (allowed_thing, other_allowed_thing)
diff --git a/content/cheatsheet/other-thing.yaml b/content/cheatsheet/other-thing.yaml
@@ -0,0 +1 @@
+key: value
diff --git a/content/docs/cheatsheet.md b/content/docs/cheatsheet.md
@@ -0,0 +1,6 @@
+---
+title: Falco Cheatsheet
+draft: true
+---
+
+{{< cheatsheet >}}
diff --git a/data/cheatsheet.yaml b/data/cheatsheet.yaml
@@ -0,0 +1,4 @@
+forbidden-thing:
+  title: Do a thing
+other-thing:
+  title: Some other thing
diff --git a/themes/falco-fresh/assets/cheatsheet.sass b/themes/falco-fresh/assets/cheatsheet.sass
@@ -0,0 +1,27 @@
+.cheatsheet
+  display: flex
+
+  +desktop
+    flex-flow: row nowrap
+  +mobile
+    flex-flow: column nowrap
+
+  flex-flow: row nowrap
+  justify-content: space-between
+
+  .cheat
+    padding: 1rem
+    background-color: $light
+
+    +desktop
+      width: calc(50% - .25rem)
+    +mobile
+      width: 100%
+
+      & + .cheat
+        margin-top: 1rem
+
+    &-title
+      font-size: 1.25rem
+      font-weight: 700
+
diff --git a/themes/falco-fresh/assets/style.sass b/themes/falco-fresh/assets/style.sass
@@ -27,6 +27,7 @@ $colors: mergeColorMaps(("twitter-blue": ($twitter-blue, $white)), $colors)
 @import "bulma-dashboard/src/bulma-dashboard"
 
 @import "toc"
+@import "cheatsheet"
 
 .is-cncf-logo
   margin-top: 2rem

diff --git a/themes/falco-fresh/layouts/shortcodes/cheat.html b/themes/falco-fresh/layouts/shortcodes/cheat.html
@@ -0,0 +1,8 @@
+{{ $key   := .Get 0 }}
+{{ $cheat := index site.Data.cheatsheet $key }}
+{{ $title := $cheat.title }}
+{{ $file  := printf "cheatsheet/%s.yaml" $key }}
+{{ $yaml  := readFile $file }}
+<h2>{{ $title }}</h2>
+
+{{ highlight $yaml "yaml" "" }}
diff --git a/themes/falco-fresh/layouts/shortcodes/cheatsheet.html b/themes/falco-fresh/layouts/shortcodes/cheatsheet.html
@@ -0,0 +1,14 @@
+{{ $cheats := site.Data.cheatsheet }}
+<div class="cheatsheet">
+  {{ range $k, $v := $cheats }}
+  {{ $yaml  := readFile (printf "cheatsheet/%s.yaml" $k) }}
+  {{ $title := $v.title | markdownify }}
+  <div class="cheat">
+    <p class="cheat-title">
+      {{ $title }}
+    </p>
+
+    {{ highlight $yaml "yaml" "" }}
+  </div>
+  {{ end }}
+</div>