use mkdocs-awesome-pages-plugin

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
kyverno · Oct 9, 2023 · 181f2d0 · 181f2d0
1 parent e11c8fc
commit 181f2d0
Show file tree

Hide file tree

Showing 38 changed files with 192 additions and 88 deletions.
diff --git a/Makefile b/Makefile
@@ -152,7 +152,7 @@ codegen-mkdocs: codegen-docs ## Generate mkdocs website
 	@echo Generate mkdocs website... >&2
 	@pip3 install mkdocs
 	@pip3 install --upgrade pip
-	@pip3 install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin
+	@pip3 install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr mkdocs-rss-plugin mkdocs-awesome-pages-plugin
 	@rm -rf ./website/docs/apis && mkdir -p ./website/docs/apis && cp docs/user/apis/md/* ./website/docs/apis
 	@rm -rf ./website/docs/commands && mkdir -p ./website/docs/commands && cp docs/user/commands/* ./website/docs/commands
 	@rm -rf ./website/docs/jp && mkdir -p ./website/docs/jp && cp docs/user/jp/* ./website/docs/jp

diff --git a/catalog/aws/policy-1.yaml b/catalog/aws/policy-1.yaml
@@ -1,11 +1,12 @@
----
-tags:
-- aws
----
 apiVersion: json.kyverno.io/v1alpha1
 kind: Policy
 metadata:
   name: test
+  labels:
+    s3.aws.catalog.kyverno.io: ''
+  annotations:
+    title.catalog.kyverno.io: Policy 1
+    description.catalog.kyverno.io: Policy 1
 spec:
   rules:
     - name: foo-bar

diff --git a/catalog/ecs/policy-1.yaml b/catalog/ecs/policy-1.yaml
@@ -1,7 +1,3 @@
----
-tags:
-- ecs
----
 apiVersion: json.kyverno.io/v1alpha1
 kind: Policy
 metadata:

diff --git a/hack/docs/catalog/main.go b/hack/docs/catalog/main.go
@@ -0,0 +1,38 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/kyverno/kyverno-json/pkg/policy"
+	"sigs.k8s.io/yaml"
+)
+
+func main() {
+	policies, err := policy.Load("./catalog")
+	if err != nil {
+		panic(err)
+	}
+	for i, policy := range policies {
+		f, err := os.Create("website/docs/catalog/policies/" + fmt.Sprintf("%d.md", i))
+		if err != nil {
+			panic(err)
+		}
+		defer f.Close()
+		bytes, err := yaml.Marshal(policy)
+		if err != nil {
+			panic(err)
+		}
+		fmt.Fprintln(f, "# "+policy.Annotations["title.catalog.kyverno.io"])
+		fmt.Fprintln(f)
+		fmt.Fprintln(f, policy.Annotations["description.catalog.kyverno.io"])
+		fmt.Fprintln(f)
+		fmt.Fprintln(f, "## Manifest")
+		fmt.Fprintln(f)
+		fmt.Fprintln(f, "```yaml")
+		if _, err := f.Write(bytes); err != nil {
+			panic(err)
+		}
+		fmt.Fprintln(f, "```")
+	}
+}
diff --git a/website/docs/.pages b/website/docs/.pages
@@ -0,0 +1,8 @@
+nav:
+- Home: index.md
+- start
+- policies
+- Policy catalog:
+  - catalog/index.md
+- playground
+- blog
diff --git a/website/docs/blog/.pages b/website/docs/blog/.pages
@@ -0,0 +1,3 @@
+nav:
+- Blog:
+  - index.md
diff --git a/website/docs/catalog/aws/policy-1.md b/website/docs/catalog/aws/policy-1.md
diff --git a/website/docs/catalog/ecs/policy-1.md b/website/docs/catalog/ecs/policy-1.md
diff --git a/website/docs/catalog/policies/.pages b/website/docs/catalog/policies/.pages
@@ -0,0 +1,3 @@
+nav:
+- 0.md
+- 1.md
diff --git a/website/docs/catalog/policies/0.md b/website/docs/catalog/policies/0.md
@@ -0,0 +1,26 @@
+# Policy 1
+
+Policy 1
+
+## Manifest
+
+```yaml
+apiVersion: json.kyverno.io/v1alpha1
+kind: Policy
+metadata:
+  annotations:
+    description.catalog.kyverno.io: Policy 1
+    title.catalog.kyverno.io: Policy 1
+  creationTimestamp: null
+  labels:
+    s3.aws.catalog.kyverno.io: ""
+  name: test
+spec:
+  rules:
+  - name: foo-bar
+    validate:
+      assert:
+        all:
+        - foo:
+            /(bar)/: 10
+```
diff --git a/website/docs/catalog/policies/1.md b/website/docs/catalog/policies/1.md
@@ -0,0 +1,21 @@
+# 
+
+
+
+## Manifest
+
+```yaml
+apiVersion: json.kyverno.io/v1alpha1
+kind: Policy
+metadata:
+  creationTimestamp: null
+  name: test
+spec:
+  rules:
+  - name: foo-bar
+    validate:
+      assert:
+        all:
+        - foo:
+            /(bar)/: 10
+```
diff --git a/website/docs/playground/.pages b/website/docs/playground/.pages
@@ -0,0 +1,3 @@
+nav:
+- Playground:
+  - index.md
diff --git a/website/docs/playground.md → website/docs/playground/index.md b/website/docs/playground.md → website/docs/playground/index.md
diff --git a/website/docs/policies/.pages b/website/docs/policies/.pages
@@ -0,0 +1,13 @@
+nav:
+- Writing policies:
+  - index.md
+  - Basics:
+    - api-version.md
+    - match.md
+    - assertion-trees.md
+    - modifiers.md
+    - explicit-bindings.md
+    - escaping.md
+  - commands
+  - jp
+  - apis
diff --git a/website/docs/policies/apis/.pages b/website/docs/policies/apis/.pages
@@ -0,0 +1,3 @@
+nav:
+- APIs:
+  - v1alpha1: kyverno-json.v1alpha1.md
diff --git a/website/docs/apis/kyverno-json.v1alpha1.md → ...cs/policies/apis/kyverno-json.v1alpha1.md b/website/docs/apis/kyverno-json.v1alpha1.md → ...cs/policies/apis/kyverno-json.v1alpha1.md
diff --git a/website/docs/policies/commands/.pages b/website/docs/policies/commands/.pages
@@ -0,0 +1,15 @@
+nav:
+- Command Line Usage:
+  - kyverno-json.md
+  - kyverno-json_completion.md
+  - kyverno-json_completion_bash.md
+  - kyverno-json_completion_fish.md
+  - kyverno-json_completion_powershell.md
+  - kyverno-json_completion_zsh.md
+  - kyverno-json_docs.md
+  - kyverno-json_jp.md
+  - kyverno-json_jp_function.md
+  - kyverno-json_jp_parse.md
+  - kyverno-json_jp_query.md
+  - kyverno-json_scan.md
+  - kyverno-json_version.md
diff --git a/website/docs/commands/kyverno-json.md → ...te/docs/policies/commands/kyverno-json.md b/website/docs/commands/kyverno-json.md → ...te/docs/policies/commands/kyverno-json.md
diff --git a/.../docs/commands/kyverno-json_completion.md → ...icies/commands/kyverno-json_completion.md b/.../docs/commands/kyverno-json_completion.md → ...icies/commands/kyverno-json_completion.md
diff --git a/.../commands/kyverno-json_completion_bash.md → .../commands/kyverno-json_completion_bash.md b/.../commands/kyverno-json_completion_bash.md → .../commands/kyverno-json_completion_bash.md
diff --git a/.../commands/kyverno-json_completion_fish.md → .../commands/kyverno-json_completion_fish.md b/.../commands/kyverno-json_completion_fish.md → .../commands/kyverno-json_completion_fish.md
diff --git a/...nds/kyverno-json_completion_powershell.md → ...nds/kyverno-json_completion_powershell.md b/...nds/kyverno-json_completion_powershell.md → ...nds/kyverno-json_completion_powershell.md
diff --git a/...s/commands/kyverno-json_completion_zsh.md → ...s/commands/kyverno-json_completion_zsh.md b/...s/commands/kyverno-json_completion_zsh.md → ...s/commands/kyverno-json_completion_zsh.md
diff --git a/website/docs/commands/kyverno-json_docs.md → ...cs/policies/commands/kyverno-json_docs.md b/website/docs/commands/kyverno-json_docs.md → ...cs/policies/commands/kyverno-json_docs.md
diff --git a/website/docs/commands/kyverno-json_jp.md → ...docs/policies/commands/kyverno-json_jp.md b/website/docs/commands/kyverno-json_jp.md → ...docs/policies/commands/kyverno-json_jp.md
diff --git a/...docs/commands/kyverno-json_jp_function.md → ...cies/commands/kyverno-json_jp_function.md b/...docs/commands/kyverno-json_jp_function.md → ...cies/commands/kyverno-json_jp_function.md
diff --git a/...te/docs/commands/kyverno-json_jp_parse.md → ...olicies/commands/kyverno-json_jp_parse.md b/...te/docs/commands/kyverno-json_jp_parse.md → ...olicies/commands/kyverno-json_jp_parse.md
diff --git a/...te/docs/commands/kyverno-json_jp_query.md → ...olicies/commands/kyverno-json_jp_query.md b/...te/docs/commands/kyverno-json_jp_query.md → ...olicies/commands/kyverno-json_jp_query.md
diff --git a/website/docs/commands/kyverno-json_scan.md → ...cs/policies/commands/kyverno-json_scan.md b/website/docs/commands/kyverno-json_scan.md → ...cs/policies/commands/kyverno-json_scan.md
diff --git a/...ite/docs/commands/kyverno-json_version.md → ...policies/commands/kyverno-json_version.md b/...ite/docs/commands/kyverno-json_version.md → ...policies/commands/kyverno-json_version.md
diff --git a/website/docs/policies/jp/.pages b/website/docs/policies/jp/.pages
@@ -0,0 +1,4 @@
+nav:
+- JMESPath:
+  - Overview: overview.md
+  - Functions: functions.md
diff --git a/website/docs/jp/functions.md → website/docs/policies/jp/functions.md b/website/docs/jp/functions.md → website/docs/policies/jp/functions.md
diff --git a/website/docs/jp.md → website/docs/policies/jp/overview.md b/website/docs/jp.md → website/docs/policies/jp/overview.md
diff --git a/website/docs/start/.pages b/website/docs/start/.pages
@@ -0,0 +1,5 @@
+nav:
+- Getting Started:
+  - index.md
+  - install.md
+  - quick-start.md
diff --git a/website/docs/intro.md → website/docs/start/index.md b/website/docs/intro.md → website/docs/start/index.md
diff --git a/website/docs/install.md → website/docs/start/install.md b/website/docs/install.md → website/docs/start/install.md
diff --git a/website/docs/quick-start.md → website/docs/start/quick-start.md b/website/docs/quick-start.md → website/docs/start/quick-start.md
diff --git a/website/mkdocs.yaml b/website/mkdocs.yaml
@@ -51,6 +51,9 @@ theme:
 
 plugins:
 - search
+- awesome-pages:
+    strict: false
+    collapse_single_pages: true
 # - redirects:
 #     redirect_maps:
 #       discord.md: https://discord.gg/RGEBtg8vQ6
@@ -71,48 +74,47 @@ plugins:
 - blog:
     post_url_format: "{slug}"
 
-nav:
-- Home: index.md
-- Getting Started:
-  - intro.md
-  - install.md
-  - quick-start.md
-- Writing policies:
-  - policies/index.md
-  - Basics:
-    - policies/api-version.md
-    - policies/match.md
-    - policies/assertion-trees.md
-    - policies/modifiers.md
-    - policies/explicit-bindings.md
-    - policies/escaping.md
-  - Command Line Usage:
-    - commands/kyverno-json.md
-    - commands/kyverno-json_completion.md
-    - commands/kyverno-json_completion_bash.md
-    - commands/kyverno-json_completion_fish.md
-    - commands/kyverno-json_completion_powershell.md
-    - commands/kyverno-json_completion_zsh.md
-    - commands/kyverno-json_docs.md
-    - commands/kyverno-json_jp.md
-    - commands/kyverno-json_jp_function.md
-    - commands/kyverno-json_jp_parse.md
-    - commands/kyverno-json_jp_query.md
-    - commands/kyverno-json_scan.md
-    - commands/kyverno-json_version.md
-  - JMESPath:
-    - Overview: jp.md
-    - Functions: jp/functions.md
-  - APIs:
-    - v1alpha1: apis/kyverno-json.v1alpha1.md
-- Policy catalog:
-  - catalog/index.md
-  - catalog/aws/policy-1.md
-  - catalog/ecs/policy-1.md
-- Playground:
-  - playground.md
-- Blog:
-  - blog/index.md
+# nav:
+# - Home: index.md
+# - Getting Started:
+#   - intro.md
+#   - install.md
+#   - quick-start.md
+# - Writing policies:
+#   - policies/index.md
+#   - Basics:
+#     - policies/api-version.md
+#     - policies/match.md
+#     - policies/assertion-trees.md
+#     - policies/modifiers.md
+#     - policies/explicit-bindings.md
+#     - policies/escaping.md
+#   - Command Line Usage:
+#     - commands/kyverno-json.md
+#     - commands/kyverno-json_completion.md
+#     - commands/kyverno-json_completion_bash.md
+#     - commands/kyverno-json_completion_fish.md
+#     - commands/kyverno-json_completion_powershell.md
+#     - commands/kyverno-json_completion_zsh.md
+#     - commands/kyverno-json_docs.md
+#     - commands/kyverno-json_jp.md
+#     - commands/kyverno-json_jp_function.md
+#     - commands/kyverno-json_jp_parse.md
+#     - commands/kyverno-json_jp_query.md
+#     - commands/kyverno-json_scan.md
+#     - commands/kyverno-json_version.md
+#   - JMESPath:
+#     - Overview: jp.md
+#     - Functions: jp/functions.md
+#   - APIs:
+#     - v1alpha1: apis/kyverno-json.v1alpha1.md
+# - Policy catalog:
+#   - catalog/index.md
+#   - catalog/policies
+# - Playground:
+#   - playground.md
+# - Blog:
+#   - blog/index.md
 
 markdown_extensions:
 - admonition
-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    nav:
+    - 0.md
+    - 1.md