feat: add blog and integrations page

* feat: add integrations category

* chore: integration sidebar

* chore: swizzle docsauraus components

* chore: update components

* chore: move main docs under guide

* chore: sidebar index page generator

* chore: blog

* chore: doc updates

* chore: bump modules

* chore: fix broken links

* doc fixes

* chore: docs fix

.gitmodules

@@ -17,3 +17,9 @@
 [submodule "modules/mission-control-registry"]
 	path = modules/mission-control-registry
 	url = https://github.com/flanksource/mission-control-registry.git
+[submodule "mission-control-chart"]
+	path = mission-control-chart
+	url = https://github.com/flanksource/mission-control-chart.git
+[submodule "modules/mission-control-chart"]
+	path = modules/mission-control-chart
+	url = https://github.com/flanksource/mission-control-chart.git

Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+jinja2 = "*"
+python-box = "*"
+
+[requires]
+python_version = "3.11"
+
+[scripts]
+sidebar = "python process_sidebar.py"

canary-checker/docs/comparisons/blackbox-exporter.md

@@ -1,3 +1,8 @@
+---
+title: Blackbox Exporter
+sidebar_custom_props:
+  icon: prometheus
+---
 # Canary-Checker vs Prometheus blackbox exporter
 
 [Prometheus Blackbox Exporter](https://github.com/prometheus/blackbox_exporter) is a prometheus exporter for probing HTTP, HTTPS, DNS, TCP, ICMP, and gRPC.

canary-checker/docs/comparisons/index.md

@@ -0,0 +1,6 @@
+---
+title: Comparisons
+sidebar_position: 3
+sidebar_custom_props:
+  icon: material-symbols-light:text-compare-outline
+---

canary-checker/docs/comparisons/kuberhealthy.md

@@ -0,0 +1,14 @@
+---
+draft: true
+---
+### Kuberhealthy
+
+https://github.com/kuberhealthy/kuberhealthy
+
+**Kuberhealthy is a [Kubernetes](https://kubernetes.io/) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) for [synthetic monitoring](https://en.wikipedia.org/wiki/Synthetic_monitoring) and [continuous process verification](https://en.wikipedia.org/wiki/Continued_process_verification).** [Write your own tests](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECK_CREATION) in any language and Kuberhealthy will run them for you. Automatically creates metrics for [Prometheus](https://prometheus.io/). Includes simple JSON What is Kuberhealthy?
+
+Kuberhealthy lets you continuously verify that your applications and Kubernetes clusters are working as expected. By creating a custom resource (a `KuberhealthyCheck`) in your cluster, you can easily enable [various synthetic tests](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS_REGISTRY) and get Prometheus metrics for them.
+
+Kuberhealthy comes with [lots of useful checks already available](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS_REGISTRY) to ensure the core functionality of Kubernetes, but checks can be used to test anything you like. We encourage you to [write your own check container](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECK_CREATION) in any language to test your own applications. It really is quick and easy!
+
+Kuberhealthy serves the status of all checks on a simple JSON status page, a [Prometheus](https://prometheus.io/) metrics endpoint (at `/metrics`), and supports InfluxDB metric forwarding for integration into your choice of alerting solution.

canary-checker/docs/comparison.md → canary-checker/docs/comparisons/prometheus-exporters.md

@@ -1,3 +1,9 @@
+---
+title: Prometheus Exporters
+sidebar_custom_props:
+  icon: prometheus
+---
+
 Canary checker can replace the following exporters:
 
 | Exporter                                                                                                                                                                              | Canary Checker Equivalent | Description |
@@ -14,29 +20,3 @@ Canary checker can replace the following exporters:
 | [s3-exporter](https://github.com/ribbybibby/s3_exporter)                                                                                                                              |                           |             |
 | [github_actions_exporter](https://github.com/cpanato/github_actions_exporter)                                                                                                         |                           |             |
 | [filestat_exporter](https://github.com/michael-doubez/filestat_exporter)                                                                                                              |                           |             |
-
-<!-- vale off -->
-
-### Prometheus Alert Manager
-
-### Blackbox Exporter
-
-### Kuberhealthy
-
-https://github.com/kuberhealthy/kuberhealthy
-
-**Kuberhealthy is a [Kubernetes](https://kubernetes.io/) [operator](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/) for [synthetic monitoring](https://en.wikipedia.org/wiki/Synthetic_monitoring) and [continuous process verification](https://en.wikipedia.org/wiki/Continued_process_verification).** [Write your own tests](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECK_CREATION) in any language and Kuberhealthy will run them for you. Automatically creates metrics for [Prometheus](https://prometheus.io/). Includes simple JSON What is Kuberhealthy?
-
-Kuberhealthy lets you continuously verify that your applications and Kubernetes clusters are working as expected. By creating a custom resource (a `KuberhealthyCheck`) in your cluster, you can easily enable [various synthetic tests](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS_REGISTRY) and get Prometheus metrics for them.
-
-Kuberhealthy comes with [lots of useful checks already available](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECKS_REGISTRY) to ensure the core functionality of Kubernetes, but checks can be used to test anything you like. We encourage you to [write your own check container](https://github.com/kuberhealthy/kuberhealthy/blob/master/docs/CHECK_CREATION) in any language to test your own applications. It really is quick and easy!
-
-Kuberhealthy serves the status of all checks on a simple JSON status page, a [Prometheus](https://prometheus.io/) metrics endpoint (at `/metrics`), and supports InfluxDB metric forwarding for integration into your choice of alerting solution.
-
-### Cloudprober
-
-https://cloudprober.org/
-
-### Karma Alert Dashboard
-
-<!-- vale on -->

canary-checker/docs/concepts/cli.mdx

@@ -3,7 +3,7 @@ title: CLI
 hide_title: true
 ---
 
-import Install from '../snippets/install.mdx'
+import Install from '@site/docs/snippets/install.mdx'
 
 ## Installation
 

canary-checker/docs/concepts/expressions/display-formatting.md

@@ -8,7 +8,7 @@ Canary checker can format the results of checks using the `display` field. All e
 
 In this example we get the current exchange rate:
 
-```yaml title="display-with-gotemplate.yaml" file=../../../../modules/canary-checker/fixtures/minimal/display-with-gotemplate_pass.yaml
+```yaml title="display-with-gotemplate.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/display-with-gotemplate_pass.yaml
 
 ```
 
@@ -24,15 +24,15 @@ See <CommonLink to="gotemplate">Go Template</CommonLink>
 
 The equivalent using CEL expressions would be:
 
-```yaml title="display-with-cel.yaml" file=../../../../modules/canary-checker/fixtures/minimal/display-with-cel_pass.yaml
+```yaml title="display-with-cel.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/display-with-cel_pass.yaml
 
 ```
 
 See <CommonLink to="cel">Cel Expressions</CommonLink> for a function reference
 
 ## Javascript
 
-```yaml title="display-with-javascript.yaml" file=../../../../modules/canary-checker/fixtures/minimal/display-with-javascript_pass.yaml
+```yaml title="display-with-javascript.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/display-with-javascript_pass.yaml
 
 ```
 

canary-checker/docs/concepts/expressions/health-evaluation.md

@@ -8,7 +8,7 @@ these default behaviors can be changed using the `test` field:
 
 In the example below the http check fails if the HTTP response header contains an 'Authorization' field.
 
-```yaml title=http-check-expr.yaml file=../../../../modules/canary-checker/fixtures/minimal/http_no_auth_pass.yaml
+```yaml title=http-check-expr.yaml file=<rootDir>/modules/canary-checker/fixtures/minimal/http_no_auth_pass.yaml
 
 ```
 

canary-checker/docs/concepts/expressions/index.md

@@ -1,5 +1,7 @@
 ---
 title: Expressions
+sidebar_custom_props:
+  icon: variable
 ---
 
 canary-checker can be extended using expressions in 3 ways:

canary-checker/docs/concepts/expressions/transforms.mdx

@@ -6,7 +6,7 @@ import TransformFields from './_transform_fields.mdx'
 
 The `transform` can be used to convert one check into multiple checks programmatically.
 
-```yaml title="alertmanager-check.yaml" file=../../../../modules/canary-checker/fixtures/datasources/alertmanager.yaml
+```yaml title="alertmanager-check.yaml" file=<rootDir>/modules/canary-checker/fixtures/datasources/alertmanager.yaml
 ```
 
 In the above example, the check returns multiple alerts from alertmanager. By default, all those alerts are grouped in a single check.

canary-checker/docs/concepts/index.md

@@ -0,0 +1,6 @@
+---
+title: Concepts
+sidebar_position: 2
+sidebar_custom_props:
+  icon: concepts
+---

canary-checker/docs/concepts/metrics/custom-metrics.md

@@ -6,7 +6,7 @@ Canary checker can export custom metrics from any check type, replacing and/or c
 
 In the example below, exchange rates against the USD are exported by first calling an HTTP api and then using the values from the JSON response to create the metrics:
 
-```yaml title="exchange-rates-exporter.yaml" file=../../../../modules/canary-checker/fixtures/minimal/metrics-multiple.yaml
+```yaml title="exchange-rates-exporter.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/metrics-multiple.yaml
 
 ```
 

canary-checker/docs/concepts/metrics/index.mdx

@@ -1,5 +1,7 @@
 ---
 title: Metrics
+sidebar_custom_props:
+  icon: clarity:dashboard-line
 ---
 
 Default Metrics exposed by canary-checker:

canary-checker/docs/concepts/metrics/stateful-metrics.md

@@ -4,7 +4,7 @@ title: Stateful Metrics
 
 Metrics can be generated from time based data, e.g. logs per minute, logins per second by using the output of one check execution as the input to the next.
 
-```yaml file=../../../../modules/canary-checker/fixtures/elasticsearch/stateful_metrics.yaml
+```yaml file=<rootDir>/modules/canary-checker/fixtures/elasticsearch/stateful_metrics.yaml
 
 ```
 

canary-checker/docs/concepts/performance.md

@@ -0,0 +1,6 @@
+## Disable Check Status Aggregation
+
+jobs.AggregateCheckStatuses1h.disable=true
+jobs.AggregateCheckStatuses1d.disable=true
+
+job.AggregateCheckStatuses1d

canary-checker/docs/concepts/secret-management.md

@@ -1,5 +1,7 @@
 ---
 title: Env Vars
+sidebar_custom_props:
+  icon: stash:search-box-light
 sidebar_position: 1
 ---
 

canary-checker/docs/examples/index.md

@@ -0,0 +1,6 @@
+---
+title: Examples
+sidebar_position: 2
+sidebar_custom_props:
+  icon: stash:graduation-cap-light
+---

canary-checker/docs/examples/k6.mdx

@@ -1,5 +1,7 @@
 ---
 title: K6
+sidebar_custom_props:
+  icon: k6
 ---
 
 # <Icon name="k6" /> K6
@@ -89,4 +91,4 @@ For a complete working example, see **[canary-checker-examples/k6](https://githu
 
 ## Test Result Variables
 
-See [JUnit Test Results](/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.
+See [JUnit Test Results](/guide/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.

canary-checker/docs/examples/newman.mdx

@@ -1,5 +1,7 @@
 ---
 title: Newman
+sidebar_custom_props:
+  icon: postman
 ---
 
 # <Icon name="postman" /> Newman
@@ -58,4 +60,4 @@ For a complete working example, see **[canary-checker-examples/newman](https://g
 
 ## Test Result Variables
 
-See [JUnit Test Results](/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.
+See [JUnit Test Results](/guide/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.

canary-checker/docs/examples/playwright.mdx

@@ -1,5 +1,7 @@
 ---
 title: Playwright
+sidebar_custom_props:
+  icon: playwright
 ---
 
 # <Icon name="playwright" /> Playwright
@@ -55,4 +57,4 @@ For a complete working example, see **[canary-checker-examples/playwright](https
 
 ## Test Result Variables
 
-See [JUnit Test Results](/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.
+See [JUnit Test Results](/guide/canary-checker/reference/junit#test-result-variables) for the schema that is ingested and can be used for evaluating health or formatting the display.