diff --git a/docs/README.md b/docs/README.md index fe74901e4c..775066c2ba 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,3 @@ ---- -title: VictoriaMetrics ---- -# VictoriaMetrics - [![Latest Release](https://img.shields.io/github/release/VictoriaMetrics/VictoriaMetrics.svg?style=flat-square)](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) [![Docker Pulls](https://img.shields.io/docker/pulls/victoriametrics/victoria-metrics.svg?maxAge=604800)](https://hub.docker.com/r/victoriametrics/victoria-metrics) [![Slack](https://img.shields.io/badge/join%20slack-%23victoriametrics-brightgreen.svg)](https://slack.victoriametrics.com/) diff --git a/docs/VictoriaLogs/README.md b/docs/VictoriaLogs/README.md index 7a80eafc4b..b2ce9004da 100644 --- a/docs/VictoriaLogs/README.md +++ b/docs/VictoriaLogs/README.md @@ -1,12 +1,3 @@ ---- -title: VictoriaLogs -weight: 0 -aliases: -- /VictoriaLogs/ -- /VictoriaLogs/index.html ---- -# VictoriaLogs - VictoriaLogs is [open source](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/app/victoria-logs) user-friendly database for logs from [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/). diff --git a/docs/VictoriaLogs/_index.md b/docs/VictoriaLogs/_index.md new file mode 100644 index 0000000000..943bb4c92d --- /dev/null +++ b/docs/VictoriaLogs/_index.md @@ -0,0 +1,8 @@ +--- +title: VictoriaLogs +weight: 0 +aliases: +- /VictoriaLogs/ +- /VictoriaLogs/index.html +--- +{{% content "README.md" %}} diff --git a/docs/VictoriaLogs/data-ingestion/README.md b/docs/VictoriaLogs/data-ingestion/README.md index eb8641f33e..b3c849d4a9 100644 --- a/docs/VictoriaLogs/data-ingestion/README.md +++ b/docs/VictoriaLogs/data-ingestion/README.md @@ -1,19 +1,3 @@ ---- -sort: 3 -title: Data ingestion -weight: 3 -menu: - docs: - identifier: victorialogs-data-ingestion - parent: "victorialogs" - weight: 3 -aliases: - - /VictoriaLogs/data-ingestion/ - - /VictoriaLogs/data-ingestion/index.html ---- - -# Data ingestion - [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/) can accept logs from the following log collectors: - Syslog, Rsyslog and Syslog-ng - see [these docs](https://docs.victoriametrics.com/victorialogs/data-ingestion/syslog/). diff --git a/docs/VictoriaLogs/data-ingestion/_index.md b/docs/VictoriaLogs/data-ingestion/_index.md new file mode 100644 index 0000000000..aab116b604 --- /dev/null +++ b/docs/VictoriaLogs/data-ingestion/_index.md @@ -0,0 +1,14 @@ +--- +sort: 3 +title: Data ingestion +weight: 3 +menu: + docs: + identifier: victorialogs-data-ingestion + parent: "victorialogs" + weight: 3 +aliases: + - /VictoriaLogs/data-ingestion/ + - /VictoriaLogs/data-ingestion/index.html +--- +{{% content "README.md" %}} diff --git a/docs/VictoriaLogs/querying/README.md b/docs/VictoriaLogs/querying/README.md index 47050cc17a..bdaad4a00a 100644 --- a/docs/VictoriaLogs/querying/README.md +++ b/docs/VictoriaLogs/querying/README.md @@ -1,19 +1,3 @@ ---- -sort: 4 -title: Querying -weight: 4 -menu: - docs: - identifier: victorialogs-querying - parent: "victorialogs" - weight: 4 -aliases: - - /VictoriaLogs/querying/ - - /VictoriaLogs/querying/index.html ---- - -# Querying - [VictoriaLogs](https://docs.victoriametrics.com/victorialogs/) can be queried with [LogsQL](https://docs.victoriametrics.com/victorialogs/logsql/) via the following ways: diff --git a/docs/VictoriaLogs/querying/_index.md b/docs/VictoriaLogs/querying/_index.md new file mode 100644 index 0000000000..d7078b0783 --- /dev/null +++ b/docs/VictoriaLogs/querying/_index.md @@ -0,0 +1,14 @@ +--- +sort: 4 +title: Querying +weight: 4 +menu: + docs: + identifier: victorialogs-querying + parent: "victorialogs" + weight: 4 +aliases: + - /VictoriaLogs/querying/ + - /VictoriaLogs/querying/index.html +--- +{{% content "README.md" %}} diff --git a/docs/_index.md b/docs/_index.md new file mode 100644 index 0000000000..182d0a87f7 --- /dev/null +++ b/docs/_index.md @@ -0,0 +1,4 @@ +--- +title: VictoriaMetrics +--- +{{% content "README.md" %}} diff --git a/docs/anomaly-detection/README.md b/docs/anomaly-detection/README.md index 381fede0f3..ef24abc35e 100644 --- a/docs/anomaly-detection/README.md +++ b/docs/anomaly-detection/README.md @@ -1,15 +1,3 @@ ---- -# sort: 14 -title: VictoriaMetrics Anomaly Detection -weight: 0 -aliases: -- /anomaly-detection.html -- /vmanomaly.html -- /vmanomaly/ ---- - -# VictoriaMetrics Anomaly Detection - In the dynamic and complex world of system monitoring, VictoriaMetrics Anomaly Detection, being a part of our [Enterprise offering](https://victoriametrics.com/products/enterprise/), stands as a pivotal tool for achieving advanced observability. It empowers SREs and DevOps teams by automating the intricate task of identifying abnormal behavior in time-series data. It goes beyond traditional threshold-based alerting, utilizing machine learning techniques to not only detect anomalies but also minimize false positives, thus reducing alert fatigue. By providing simplified alerting mechanisms atop of [unified anomaly scores](/anomaly-detection/components/models.html#vmanomaly-output), it enables teams to spot and address potential issues faster, ensuring system reliability and operational efficiency. ## Practical Guides and Installation @@ -55,4 +43,4 @@ We are eager to connect with you and adapt our solutions to your specific needs. * Interested in exploring our [Enterprise features](https://victoriametrics.com/products/enterprise), including [Anomaly Detection](https://victoriametrics.com/products/enterprise/anomaly-detection)? [Request your trial license](https://victoriametrics.com/products/enterprise/trial/) today and take the first step towards advanced system observability. --- -Our [CHANGELOG is just a click away](./CHANGELOG.md), keeping you informed about the latest updates and enhancements. \ No newline at end of file +Our [CHANGELOG is just a click away](./CHANGELOG.md), keeping you informed about the latest updates and enhancements. diff --git a/docs/anomaly-detection/_index.md b/docs/anomaly-detection/_index.md new file mode 100644 index 0000000000..c208303f07 --- /dev/null +++ b/docs/anomaly-detection/_index.md @@ -0,0 +1,10 @@ +--- +# sort: 14 +title: VictoriaMetrics Anomaly Detection +weight: 0 +aliases: +- /anomaly-detection.html +- /vmanomaly.html +- /vmanomaly/ +--- +{{% content "README.md" %}} diff --git a/docs/anomaly-detection/components/README.md b/docs/anomaly-detection/components/README.md index 0572621a20..663f274cf5 100644 --- a/docs/anomaly-detection/components/README.md +++ b/docs/anomaly-detection/components/README.md @@ -1,18 +1,3 @@ ---- -title: Components -weight: 2 -menu: - docs: - identifier: "vmanomaly-components" - parent: "anomaly-detection" - weight: 2 -aliases: - - /anomaly-detection/components/ - - /anomaly-detection/components/index.html ---- - -# Components - This chapter describes different components, that correspond to respective sections of a config to launch VictoriaMetrics Anomaly Detection (or simply [`vmanomaly`](/anomaly-detection/overview.html)) service: - [Model(s) section](models.html) - Required @@ -89,4 +74,4 @@ monitoring: pull: # Enable /metrics endpoint. addr: "0.0.0.0" port: 8490 -``` \ No newline at end of file +``` diff --git a/docs/anomaly-detection/components/_index.md b/docs/anomaly-detection/components/_index.md new file mode 100644 index 0000000000..87373604df --- /dev/null +++ b/docs/anomaly-detection/components/_index.md @@ -0,0 +1,13 @@ +--- +title: Components +weight: 2 +menu: + docs: + identifier: "vmanomaly-components" + parent: "anomaly-detection" + weight: 2 +aliases: + - /anomaly-detection/components/ + - /anomaly-detection/components/index.html +--- +{{% content "README.md" %}} diff --git a/docs/anomaly-detection/guides/README.md b/docs/anomaly-detection/guides/README.md index ace726f761..0b71f24153 100644 --- a/docs/anomaly-detection/guides/README.md +++ b/docs/anomaly-detection/guides/README.md @@ -1,19 +1,5 @@ ---- -title: Guides -weight: 3 -menu: - docs: - identifier: "anomaly-detection-guides" - parent: "anomaly-detection" - weight: 3 -aliases: - - /anomaly-detection/guides.html ---- - -# Guides - This section holds guides of how to set up and use VictoriaMetrics Anomaly Detection (or simply [`vmanomaly`](/anomaly-detection/Overview.html)) service, integrating it with different observability components. Guides: -* [Anomaly Detection & Alerting Setup](/anomaly-detection/guides/guide-vmanomaly-vmalert.html) \ No newline at end of file +* [Anomaly Detection & Alerting Setup](/anomaly-detection/guides/guide-vmanomaly-vmalert.html) diff --git a/docs/anomaly-detection/guides/_index.md b/docs/anomaly-detection/guides/_index.md new file mode 100644 index 0000000000..69c8297c7b --- /dev/null +++ b/docs/anomaly-detection/guides/_index.md @@ -0,0 +1,12 @@ +--- +title: Guides +weight: 3 +menu: + docs: + identifier: "anomaly-detection-guides" + parent: "anomaly-detection" + weight: 3 +aliases: + - /anomaly-detection/guides.html +--- +{{% content "README.md" %}} diff --git a/docs/assets/README.md b/docs/assets/README.md deleted file mode 100644 index 93e9b55bae..0000000000 --- a/docs/assets/README.md +++ /dev/null @@ -1,12 +0,0 @@ -This folder must contain only files, which are needed for generating https://docs.victoriametrics.com . - -This folder **should not contain** files specific for a particular documentation pages such as images -used in a particular doc. Such files must be placed in the same folder as the doc itself -and they must have the same prefix as the doc filename. For example, all the images for docs/foo/bar.md -should have filenames starting from docs/foo/bar. This simplifies lifetime management for these files. -For example, if the corresponding doc is removed, then it is easy to remove all the associated -images with a simple `rm -rf docs/foo/bar*` command. This also simplifies referring the associated images -from docs displayed at various views: - -- https://docs.victoriametrics.com -- https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs diff --git a/docs/assets/css/clipboard.css b/docs/assets/css/clipboard.css deleted file mode 100644 index 6c2c04a0f1..0000000000 --- a/docs/assets/css/clipboard.css +++ /dev/null @@ -1,23 +0,0 @@ -/* modification for button copy */ -.btn-copy { - position: absolute; - color: #FFF; - background: rgba(0, 0, 0, .15); - border: 0; - padding: 2px 10px; - cursor: pointer; - right: 0px; - top: 0px; -} - -.btn-copy:hover { - background: rgba(0, 0, 0, .25); -} - -/* shift snippet syntax type label if Copy button is enabled */ -.with-copy div.highlighter-rouge:after { - right: 50px !important; -} -.markdown-body .highlight pre, .markdown-body pre { - padding: 20px !important; -} \ No newline at end of file diff --git a/docs/assets/images/favicon.svg b/docs/assets/images/favicon.svg deleted file mode 100644 index 1c77b786d1..0000000000 --- a/docs/assets/images/favicon.svg +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/docs/assets/images/vm_logo.svg b/docs/assets/images/vm_logo.svg deleted file mode 100644 index 9c8396160b..0000000000 --- a/docs/assets/images/vm_logo.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/docs/assets/js/clipboard.min.js b/docs/assets/js/clipboard.min.js deleted file mode 100644 index 1e7eca40f6..0000000000 --- a/docs/assets/js/clipboard.min.js +++ /dev/null @@ -1,7 +0,0 @@ -/*! - * clipboard.js v2.0.4 - * https://zenorocha.github.io/clipboard.js - * - * Licensed MIT © Zeno Rocha - */ -!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return function(n){var o={};function r(t){if(o[t])return o[t].exports;var e=o[t]={i:t,l:!1,exports:{}};return n[t].call(e.exports,e,e.exports,r),e.l=!0,e.exports}return r.m=n,r.c=o,r.d=function(t,e,n){r.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:n})},r.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return r.d(e,"a",e),e},r.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},r.p="",r(r.s=0)}([function(t,e,n){"use strict";var r="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},i=function(){function o(t,e){for(var n=0;n}}) section. diff --git a/docs/data-ingestion/_index.md b/docs/data-ingestion/_index.md new file mode 100644 index 0000000000..337d726c06 --- /dev/null +++ b/docs/data-ingestion/_index.md @@ -0,0 +1,15 @@ +--- +# sort: 14 +title: Data Ingestion +weight: 0 +menu: + docs: + parent: 'victoriametrics' + identifier: 'data-ingestion' + weight: 7 +aliases: +- /data-ingestion.html +- /data-ingestion.html +- /dataingestion/ +--- +{{% content "README.md" %}} diff --git a/docs/guides/README.md b/docs/guides/README.md index 850140e9f9..4e374fa2a5 100644 --- a/docs/guides/README.md +++ b/docs/guides/README.md @@ -1,15 +1,3 @@ ---- -sort: 26 -weight: 01 -disableToc: true -menu: - docs: - parent: "guides" - weight: 01 ---- - -# Guides - 1. [K8s monitoring via VM Single](k8s-monitoring-via-vm-single.html) 1. [K8s monitoring via VM Cluster](k8s-monitoring-via-vm-cluster.html) 1. [HA monitoring setup in K8s via VM Cluster](k8s-ha-monitoring-via-vm-cluster.html) diff --git a/docs/guides/_index.md b/docs/guides/_index.md new file mode 100644 index 0000000000..c7fbe306d1 --- /dev/null +++ b/docs/guides/_index.md @@ -0,0 +1,10 @@ +--- +sort: 26 +weight: 01 +disableToc: true +menu: + docs: + parent: "guides" + weight: 01 +--- +{{% content "README.md" %}} diff --git a/docs/managed-victoriametrics/README.md b/docs/managed-victoriametrics/README.md index c6d56182cb..63a0ebb1f7 100644 --- a/docs/managed-victoriametrics/README.md +++ b/docs/managed-victoriametrics/README.md @@ -1,12 +1,3 @@ ---- -sort: 28 -title: Managed VictoriaMetrics -weight: 01 -disableToc: true ---- - -# Managed VictoriaMetrics - * [Overview of Managed VictoriaMetrics](/managed-victoriametrics/overview/) * [Quick Start](/managed-victoriametrics/quickstart/) diff --git a/docs/managed-victoriametrics/_index.md b/docs/managed-victoriametrics/_index.md new file mode 100644 index 0000000000..818de3df11 --- /dev/null +++ b/docs/managed-victoriametrics/_index.md @@ -0,0 +1,7 @@ +--- +sort: 28 +title: Managed VictoriaMetrics +weight: 01 +disableToc: true +--- +{{% content "README.md" %}} diff --git a/docs/operator/README.md b/docs/operator/README.md index 9185fdf7db..02c81d9461 100644 --- a/docs/operator/README.md +++ b/docs/operator/README.md @@ -1,11 +1,3 @@ ---- -sort: 0 -weight: 0 -title: VictoriaMetrics Operator ---- - -# VictoriaMetrics Operator - Operator serves to make running VictoriaMetrics applications on top of Kubernetes as easy as possible while preserving Kubernetes-native configuration options. VictoriaMetrics Operator (`vmoperator`) is the classic kubernetes-operator for VictoriaMetrics with many [great features](#features). diff --git a/docs/operator/_index.md b/docs/operator/_index.md new file mode 100644 index 0000000000..f7e5948f60 --- /dev/null +++ b/docs/operator/_index.md @@ -0,0 +1,6 @@ +--- +sort: 0 +weight: 0 +title: VictoriaMetrics Operator +--- +{{% content "README.md" %}} diff --git a/docs/operator/resources/README.md b/docs/operator/resources/README.md index 98e7235926..a6657ed17d 100644 --- a/docs/operator/resources/README.md +++ b/docs/operator/resources/README.md @@ -1,16 +1,3 @@ ---- -sort: 14 -weight: 14 -title: Custom resources -menu: - docs: - identifier: operator-custom-resources - parent: "operator" - weight: 14 ---- - -# Custom resource kinds - This documentation section describes the design and interaction between the custom resource definitions (CRD) that the Victoria Metrics Operator introduces. diff --git a/docs/operator/resources/_index.md b/docs/operator/resources/_index.md new file mode 100644 index 0000000000..1e48b7b750 --- /dev/null +++ b/docs/operator/resources/_index.md @@ -0,0 +1,11 @@ +--- +sort: 14 +weight: 14 +title: Custom resources +menu: + docs: + identifier: operator-custom-resources + parent: "operator" + weight: 14 +--- +{{% content "README.md" %}}