github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-21 14:44:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

added _index.md for hugo, which point to README.md (#6686)

Browse source 
### Describe Your Changes

Please provide a brief description of the changes you made. Be as
specific as possible to help others understand the purpose and impact of
your modifications.

### Checklist

The following checks are **mandatory**:

- [ ] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
This commit is contained in:
Andrii Chubatiuk 2024-07-23 17:30:49 +03:00 committed by GitHub
parent b515a7b69b
commit 332b7788fb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
29 changed files with 127 additions and 221 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/README.md
View file

@ -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/)

9
docs/VictoriaLogs/README.md
View file

@ -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/).

8
docs/VictoriaLogs/_index.md Normal file
View file

@ -0,0 +1,8 @@
---
title: VictoriaLogs
weight: 0
aliases:
- /VictoriaLogs/
- /VictoriaLogs/index.html
---
{{% content "README.md" %}}

16
docs/VictoriaLogs/data-ingestion/README.md
View file

@ -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/).

14
docs/VictoriaLogs/data-ingestion/_index.md Normal file
View file

@ -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" %}}

16
docs/VictoriaLogs/querying/README.md
View file

@ -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:

14
docs/VictoriaLogs/querying/_index.md Normal file
View file

@ -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" %}}

4
docs/_index.md Normal file
View file

@ -0,0 +1,4 @@
---
title: VictoriaMetrics
---
{{% content "README.md" %}}

14
docs/anomaly-detection/README.md
View file

@ -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.
Our [CHANGELOG is just a click away](./CHANGELOG.md), keeping you informed about the latest updates and enhancements.

10
docs/anomaly-detection/_index.md Normal file
View file

@ -0,0 +1,10 @@
---
# sort: 14
title: VictoriaMetrics Anomaly Detection
weight: 0
aliases:
- /anomaly-detection.html
- /vmanomaly.html
- /vmanomaly/
---
{{% content "README.md" %}}

17
docs/anomaly-detection/components/README.md
View file

@ -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
```
```

13
docs/anomaly-detection/components/_index.md Normal file
View file

@ -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" %}}

16
docs/anomaly-detection/guides/README.md
View file

@ -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)
* [Anomaly Detection & Alerting Setup](/anomaly-detection/guides/guide-vmanomaly-vmalert.html)

12
docs/anomaly-detection/guides/_index.md Normal file
View file

@ -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" %}}

12
docs/assets/README.md
View file

@ -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

23
docs/assets/css/clipboard.css
View file

@ -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;
}

30
docs/assets/images/favicon.svg
View file

@ -1,30 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 24.3.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 16 16" style="enable-background:new 0 0 16 16;" xml:space="preserve">
<style type="text/css">
.st0{fill:#110F0F;}
</style>
<g>
<g>
<path class="st0" d="M6.81,7.04c0.27,0.23,0.72,0.4,1.17,0.41v0c0.01,0,0.02,0,0.02,0c0.01,0,0.02,0,0.02,0v0
c0.45-0.01,0.9-0.18,1.17-0.41c1.41-1.2,5.5-4.95,5.5-4.95c1.1-1.02-1.95-2.03-6.67-2.04v0c0,0-0.01,0-0.01,0
c-0.01,0-0.01,0-0.02,0c-0.01,0-0.01,0-0.02,0c0,0-0.01,0-0.01,0v0C3.26,0.06,0.21,1.07,1.31,2.09C1.31,2.09,5.39,5.84,6.81,7.04z
"/>
</g>
<g>
<path class="st0" d="M9.19,9.07C8.93,9.3,8.48,9.47,8.02,9.48v0c-0.01,0-0.02,0-0.02,0v0c0,0,0,0,0,0c0,0,0,0,0,0v0
c-0.01,0-0.02,0-0.02,0v0C7.52,9.47,7.07,9.3,6.81,9.07C5.83,8.24,2.38,5.11,1.09,3.93c0,0.77,0,1.41,0,1.81
c0,0.2,0.08,0.46,0.21,0.59c0.88,0.81,4.28,3.92,5.51,4.97c0.27,0.23,0.72,0.4,1.17,0.41v0c0.01,0,0.02,0,0.02,0
c0.01,0,0.02,0,0.02,0v0c0.45-0.01,0.9-0.18,1.17-0.41c1.22-1.04,4.63-4.16,5.51-4.97c0.14-0.12,0.21-0.39,0.21-0.59
c0-0.4,0-1.04,0-1.81C13.62,5.11,10.17,8.24,9.19,9.07z"/>
</g>
<g>
<path class="st0" d="M9.19,13.32c-0.27,0.23-0.72,0.4-1.17,0.41v0c-0.01,0-0.02,0-0.02,0v0c0,0,0,0,0,0c0,0,0,0,0,0v0
c-0.01,0-0.02,0-0.02,0v0c-0.45-0.01-0.9-0.18-1.17-0.41c-0.98-0.83-4.42-3.96-5.72-5.14c0,0.77,0,1.41,0,1.81
c0,0.2,0.08,0.46,0.21,0.59c0.88,0.81,4.28,3.92,5.51,4.97c0.27,0.23,0.72,0.4,1.17,0.41v0c0.01,0,0.02,0,0.02,0
c0.01,0,0.02,0,0.02,0v0c0.45-0.01,0.9-0.18,1.17-0.41c1.22-1.04,4.63-4.16,5.51-4.97c0.14-0.12,0.21-0.39,0.21-0.59
c0-0.4,0-1.04,0-1.81C13.62,9.36,10.17,12.48,9.19,13.32z"/>
</g>
</g>
</svg>
Side by side

Before

Width:  |  Height:  |  Size: 1.8 KiB

1
docs/assets/images/vm_logo.svg
View file

@ -1 +0,0 @@
<svg id="VM_logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 464.61 533.89"><defs><style>.cls-1{fill:#fff;}</style></defs><path class="cls-1" d="M459.86,467.77c9,7.67,24.12,13.49,39.3,13.69v0h1.68v0c15.18-.2,30.31-6,39.3-13.69,47.43-40.45,184.65-166.24,184.65-166.24,36.84-34.27-65.64-68.28-223.95-68.47h-1.68c-158.31.19-260.79,34.2-224,68.47C275.21,301.53,412.43,427.32,459.86,467.77Z" transform="translate(-267.7 -233.05)"/><path class="cls-1" d="M540.1,535.88c-9,7.67-24.12,13.5-39.3,13.7h-1.6c-15.18-.2-30.31-6-39.3-13.7-32.81-28-148.56-132.93-192.16-172.7v60.74c0,6.67,2.55,15.52,7.09,19.68,29.64,27.18,143.94,131.8,185.07,166.88,9,7.67,24.12,13.49,39.3,13.69v0h1.6v0c15.18-.2,30.31-6,39.3-13.69,41.13-35.08,155.43-139.7,185.07-166.88,4.54-4.16,7.09-13,7.09-19.68V363.18C688.66,403,572.91,507.9,540.1,535.88Z" transform="translate(-267.7 -233.05)"/><path class="cls-1" d="M540.1,678.64c-9,7.67-24.12,13.49-39.3,13.69v0h-1.6v0c-15.18-.2-30.31-6-39.3-13.69-32.81-28-148.56-132.94-192.16-172.7v60.73c0,6.67,2.55,15.53,7.09,19.69,29.64,27.17,143.94,131.8,185.07,166.87,9,7.67,24.12,13.5,39.3,13.7h1.6c15.18-.2,30.31-6,39.3-13.7,41.13-35.07,155.43-139.7,185.07-166.87,4.54-4.16,7.09-13,7.09-19.69V505.94C688.66,545.7,572.91,650.66,540.1,678.64Z" transform="translate(-267.7 -233.05)"/></svg>
Side by side

Before

Width:  |  Height:  |  Size: 1.3 KiB

7
docs/assets/js/clipboard.min.js vendored
View file

File diff suppressed because one or more lines are too long

16
docs/data-ingestion/README.md
View file

@ -1,19 +1,3 @@
---
# sort: 14
title: Data Ingestion
weight: 0
menu:
docs:
parent: 'victoriametrics'
identifier: 'data-ingestion'
weight: 7
aliases:
- /data-ingestion.html
- /data-ingestion.html
- /dataingestion/
---
# Data Ingestion
In This Folder you will find instructions for sending data to VictoriaMetrics from a variety of platforms.
If your tool is not listed it is likely you can ingest your data into VictoriaMetrics using one of the protocols listed in our [Prominent features]({{< ref "/Single-server-VictoriaMetrics.md#prominent-features" >}}) section.

15
docs/data-ingestion/_index.md Normal file
View file

@ -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" %}}

12
docs/guides/README.md
View file

@ -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)

10
docs/guides/_index.md Normal file
View file

@ -0,0 +1,10 @@
---
sort: 26
weight: 01
disableToc: true
menu:
docs:
parent: "guides"
weight: 01
---
{{% content "README.md" %}}

9
docs/managed-victoriametrics/README.md
View file

@ -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/)

7
docs/managed-victoriametrics/_index.md Normal file
View file

@ -0,0 +1,7 @@
---
sort: 28
title: Managed VictoriaMetrics
weight: 01
disableToc: true
---
{{% content "README.md" %}}

8
docs/operator/README.md
View file

@ -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).

6
docs/operator/_index.md Normal file
View file

@ -0,0 +1,6 @@
---
sort: 0
weight: 0
title: VictoriaMetrics Operator
---
{{% content "README.md" %}}

13
docs/operator/resources/README.md
View file

@ -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.

11
docs/operator/resources/_index.md Normal file
View file

@ -0,0 +1,11 @@
---
sort: 14
weight: 14
title: Custom resources
menu:
docs:
identifier: operator-custom-resources
parent: "operator"
weight: 14
---
{{% content "README.md" %}}