From f791811b150bb42d988230fa7b15a31777772105 Mon Sep 17 00:00:00 2001
From: Artem Navoiev <tenmozes@gmail.com>
Date: Thu, 25 May 2023 21:26:36 +0200
Subject: [PATCH] update docs-sync Makefile command, add hugo front-matter

Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
---
 Makefile                              | 38 ++++++++++++++++-----------
 docs/README.md                        |  4 ++-
 docs/Single-server-VictoriaMetrics.md |  9 ++++++-
 docs/vmagent.md                       |  9 ++++++-
 docs/vmalert.md                       |  9 ++++++-
 docs/vmauth.md                        |  9 ++++++-
 docs/vmbackup.md                      |  9 ++++++-
 docs/vmbackupmanager.md               |  9 ++++++-
 docs/vmctl.md                         |  9 ++++++-
 docs/vmgateway.md                     |  9 ++++++-
 docs/vmrestore.md                     |  9 ++++++-
 11 files changed, 98 insertions(+), 25 deletions(-)

diff --git a/Makefile b/Makefile
index cddd06ced..5a49adb80 100644
--- a/Makefile
+++ b/Makefile
@@ -418,27 +418,35 @@ check-licenses: install-wwhrd
 	wwhrd check -f .wwhrd.yml
 
 copy-docs:
-	echo '' > ${DST}
+	echo "---" > ${DST}
 	@if [ ${ORDER} -ne 0 ]; then \
-		echo "---\nsort: ${ORDER}\n---\n" > ${DST}; \
+		echo "sort: ${ORDER}" >> ${DST}; \
+		echo "weight: ${ORDER}" >> ${DST}; \
+		echo "menu:\n  docs:\n    parent: 'victoriametrics'\n    weight: ${ORDER}" >> ${DST}; \
 	fi
+
+	echo "title: ${TITLE}" >> ${DST}
+	@if [ ${OLD_URL} ]; then \
+		echo "aliases:\n  - ${OLD_URL}" >> ${DST}; \
+	fi
+	echo "---" >> ${DST}
 	cat ${SRC} >> ${DST}
 	sed -i='.tmp' 's/<img src=\"docs\//<img src=\"/' ${DST}
 	rm -rf docs/*.tmp
 
-# Copies docs for all components and adds the order tag.
-# For ORDER=0 it adds no order tag.
+# Copies docs for all components and adds the order/weight tag, title, menu position and alias with the backward compatible link for the old site.
+# For ORDER=0 it adds no order tag/weight tag.
+# FOR OLD_URL='' it adds no alias.
 # Images starting with <img src="docs/ are replaced with <img src="
-# Cluster docs are supposed to be ordered as 9th.
 # The rest of docs is ordered manually.
 docs-sync:
-	SRC=README.md DST=docs/README.md ORDER=0 $(MAKE) copy-docs
-	SRC=README.md DST=docs/Single-server-VictoriaMetrics.md ORDER=1 $(MAKE) copy-docs
-	SRC=app/vmagent/README.md DST=docs/vmagent.md ORDER=3 $(MAKE) copy-docs
-	SRC=app/vmalert/README.md DST=docs/vmalert.md ORDER=4 $(MAKE) copy-docs
-	SRC=app/vmauth/README.md DST=docs/vmauth.md ORDER=5 $(MAKE) copy-docs
-	SRC=app/vmbackup/README.md DST=docs/vmbackup.md ORDER=6 $(MAKE) copy-docs
-	SRC=app/vmrestore/README.md DST=docs/vmrestore.md ORDER=7 $(MAKE) copy-docs
-	SRC=app/vmctl/README.md DST=docs/vmctl.md ORDER=8 $(MAKE) copy-docs
-	SRC=app/vmgateway/README.md DST=docs/vmgateway.md ORDER=9 $(MAKE) copy-docs
-	SRC=app/vmbackupmanager/README.md DST=docs/vmbackupmanager.md ORDER=10 $(MAKE) copy-docs
+	SRC=README.md DST=docs/README.md OLD_URL='' ORDER=0 TITLE=VictoriaMetrics $(MAKE) copy-docs
+	SRC=README.md DST=docs/Single-server-VictoriaMetrics.md OLD_URL='/Single-server-VictoriaMetrics.html' TITLE=VictoriaMetrics ORDER=1 $(MAKE) copy-docs
+	SRC=app/vmagent/README.md DST=docs/vmagent.md OLD_URL='/vmagent.html' ORDER=3 TITLE=vmagent $(MAKE) copy-docs
+	SRC=app/vmalert/README.md DST=docs/vmalert.md OLD_URL='/vmalert.html' ORDER=4 TITLE=vmalert $(MAKE) copy-docs
+	SRC=app/vmauth/README.md DST=docs/vmauth.md OLD_URL='/vmauth.html' ORDER=5 TITLE=vmauth $(MAKE) copy-docs
+	SRC=app/vmbackup/README.md DST=docs/vmbackup.md OLD_URL='/vmbackup.html' ORDER=6 TITLE=vmbackup $(MAKE) copy-docs
+	SRC=app/vmrestore/README.md DST=docs/vmrestore.md OLD_URL='/vmrestore.html' ORDER=7 TITLE=vmrestore $(MAKE) copy-docs
+	SRC=app/vmctl/README.md DST=docs/vmctl.md OLD_URL='/vmctl.html' ORDER=8 TITLE=vmctl $(MAKE) copy-docs
+	SRC=app/vmgateway/README.md DST=docs/vmgateway.md OLD_URL='/vmgateway.html' ORDER=9 TITLE=vmgateway $(MAKE) copy-docs
+	SRC=app/vmbackupmanager/README.md DST=docs/vmbackupmanager.md OLD_URL='/vmbackupmanager.html' ORDER=10 TITLE=vmbackupmanager $(MAKE) copy-docs
diff --git a/docs/README.md b/docs/README.md
index 4da2431b6..fa75034ed 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,4 +1,6 @@
-
+---
+title: VictoriaMetrics
+---
 # VictoriaMetrics
 
 [![Latest Release](https://img.shields.io/github/release/VictoriaMetrics/VictoriaMetrics.svg?style=flat-square)](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md
index 6bd0f45c0..b082b886d 100644
--- a/docs/Single-server-VictoriaMetrics.md
+++ b/docs/Single-server-VictoriaMetrics.md
@@ -1,7 +1,14 @@
 ---
 sort: 1
+weight: 1
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 1
+title: VictoriaMetrics
+aliases:
+  - /Single-server-VictoriaMetrics.html
 ---
-
 # VictoriaMetrics
 
 [![Latest Release](https://img.shields.io/github/release/VictoriaMetrics/VictoriaMetrics.svg?style=flat-square)](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest)
diff --git a/docs/vmagent.md b/docs/vmagent.md
index 4dec48853..4209bf4c2 100644
--- a/docs/vmagent.md
+++ b/docs/vmagent.md
@@ -1,7 +1,14 @@
 ---
 sort: 3
+weight: 3
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 3
+title: vmagent
+aliases:
+  - /vmagent.html
 ---
-
 # vmagent
 
 `vmagent` is a tiny agent which helps you collect metrics from various sources,
diff --git a/docs/vmalert.md b/docs/vmalert.md
index 27c77f4b7..c560d28b7 100644
--- a/docs/vmalert.md
+++ b/docs/vmalert.md
@@ -1,7 +1,14 @@
 ---
 sort: 4
+weight: 4
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 4
+title: vmalert
+aliases:
+  - /vmalert.html
 ---
-
 # vmalert
 
 `vmalert` executes a list of the given [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/)
diff --git a/docs/vmauth.md b/docs/vmauth.md
index 2840ea7a7..e5a564455 100644
--- a/docs/vmauth.md
+++ b/docs/vmauth.md
@@ -1,7 +1,14 @@
 ---
 sort: 5
+weight: 5
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 5
+title: vmauth
+aliases:
+  - /vmauth.html
 ---
-
 # vmauth
 
 `vmauth` is a simple auth proxy, router and [load balancer](#load-balancing) for [VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics).
diff --git a/docs/vmbackup.md b/docs/vmbackup.md
index 407912bec..bbbaabd37 100644
--- a/docs/vmbackup.md
+++ b/docs/vmbackup.md
@@ -1,7 +1,14 @@
 ---
 sort: 6
+weight: 6
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 6
+title: vmbackup
+aliases:
+  - /vmbackup.html
 ---
-
 # vmbackup
 
 `vmbackup` creates VictoriaMetrics data backups from [instant snapshots](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-work-with-snapshots).
diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md
index 1aace3154..e8c143be9 100644
--- a/docs/vmbackupmanager.md
+++ b/docs/vmbackupmanager.md
@@ -1,7 +1,14 @@
 ---
 sort: 10
+weight: 10
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 10
+title: vmbackupmanager
+aliases:
+  - /vmbackupmanager.html
 ---
-
 ## vmbackupmanager
 
 ***vmbackupmanager is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases)***
diff --git a/docs/vmctl.md b/docs/vmctl.md
index f93057ae1..c01e22bfe 100644
--- a/docs/vmctl.md
+++ b/docs/vmctl.md
@@ -1,7 +1,14 @@
 ---
 sort: 8
+weight: 8
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 8
+title: vmctl
+aliases:
+  - /vmctl.html
 ---
-
 # vmctl
 
 VictoriaMetrics command-line tool
diff --git a/docs/vmgateway.md b/docs/vmgateway.md
index 0a13004ab..b3a053539 100644
--- a/docs/vmgateway.md
+++ b/docs/vmgateway.md
@@ -1,7 +1,14 @@
 ---
 sort: 9
+weight: 9
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 9
+title: vmgateway
+aliases:
+  - /vmgateway.html
 ---
-
 # vmgateway
 
 ***vmgateway is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases)***
diff --git a/docs/vmrestore.md b/docs/vmrestore.md
index 57223826e..613e9585a 100644
--- a/docs/vmrestore.md
+++ b/docs/vmrestore.md
@@ -1,7 +1,14 @@
 ---
 sort: 7
+weight: 7
+menu:
+  docs:
+    parent: 'victoriametrics'
+    weight: 7
+title: vmrestore
+aliases:
+  - /vmrestore.html
 ---
-
 # vmrestore
 
 `vmrestore` restores data from backups created by [vmbackup](https://docs.victoriametrics.com/vmbackup.html).