Fixing meta tags for docs.quesma.com (#1288)

mieciu · web-flow · commit 217ace4f9e9d · 2025-02-20T13:28:20.000Z
diff --git a/docs/public/docs/.vitepress/config.mts b/docs/public/docs/.vitepress/config.mts
@@ -1,11 +1,21 @@
-import { defineConfig } from 'vitepress'
+import {defineConfig, HeadConfig} from 'vitepress'
 import { withMermaid } from "vitepress-plugin-mermaid";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: "Quesma",
-  description: "Quesma Database Gateway Early Access Program",
+  description: "Quesma Database Gateway Official Documentation",
   head: [['link', { rel: 'icon', href: 'favicon.ico' }]],
+  transformHead: ({ pageData }) => {
+    const head: HeadConfig[] = []
+    if (pageData.frontmatter.description) {
+      head.push([
+        'meta',
+        { name: 'description', content: pageData.frontmatter.description }
+      ])
+    }
+    return head
+  },
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     logo: {
diff --git a/docs/public/docs/adding-kibana-dataviews.md b/docs/public/docs/adding-kibana-dataviews.md
@@ -1,3 +1,6 @@
+---
+description: Data Views creation guide
+---
 # Data Views creation guide
 
 This guide will help you create Data Views for Hydrolix/ClickHouse tables in Kibana.
diff --git a/docs/public/docs/compatibility-report.md b/docs/public/docs/compatibility-report.md
@@ -1,3 +1,6 @@
+---
+description: Compatibility Report
+---
 # Compatibility Report
 
 Quesma can help validate your migration by sending queries to both Elasticsearch and ClickHouse simultaneously and comparing the results. This allows you to verify that queries return equivalent results from both systems before fully switching over.
diff --git a/docs/public/docs/config-primer.md b/docs/public/docs/config-primer.md
@@ -1,3 +1,6 @@
+---
+description: Configuration primer
+---
 # Configuration primer
 
 ## Configuration overview
diff --git a/docs/public/docs/eap-docs.md b/docs/public/docs/eap-docs.md
@@ -1,3 +1,6 @@
+---
+description: What is Quesma?
+---
 # What is Quesma?
 
 Quesma is an actively developed database gateway. Route your queries through a translation layer that seamlessly connects your apps with the modern database platforms of your choice. No more query refactoring during migrations.
diff --git a/docs/public/docs/example-1.md b/docs/public/docs/example-1.md
@@ -1,3 +1,6 @@
+---
+description: Transparent Elasticsearch proxy
+---
 # Transparent Elasticsearch proxy
 
 In this scenario, Quesma is used as a transparent proxy between Kibana/OpenSearchDashboards(OSD) and Elasticsearch/OpenSearch. 
diff --git a/docs/public/docs/example-2-0-clickhouse-specific.md b/docs/public/docs/example-2-0-clickhouse-specific.md
@@ -1,3 +1,6 @@
+---
+description: Query ClickHouse/Hydrolix tables as Elasticsearch indices
+---
 # Query ClickHouse/Hydrolix tables as Elasticsearch indices
 
 ::: warning
diff --git a/docs/public/docs/example-2-0.md b/docs/public/docs/example-2-0.md
@@ -1,3 +1,6 @@
+---
+description: Query Hydrolix tables as Elasticsearch indices
+---
 # Query Hydrolix tables as Elasticsearch indices
 
 In this scenario, user's only data source is Hydrolix, which contains two tables named `logs` and `siem`.
diff --git a/docs/public/docs/example-2-1-hydro-specific.md b/docs/public/docs/example-2-1-hydro-specific.md
@@ -1,3 +1,6 @@
+---
+description: Adding ClickHouse/Hydrolix tables to existing Kibana/Elasticsearch ecosystem
+---
 # Adding Hydrolix tables to existing Kibana/Elasticsearch ecosystem
 
 In this scenario, user already has data in Elasticsearch/OpenSearch indices - let's assume `index1`, `index2` and `index3`.
diff --git a/docs/public/docs/example-2-1.md b/docs/public/docs/example-2-1.md
@@ -1,3 +1,6 @@
+---
+description: Adding ClickHouse/Hydrolix tables to existing Kibana/Elasticsearch ecosystem
+---
 # Adding ClickHouse/Hydrolix tables to existing Kibana/Elasticsearch ecosystem
 
 ::: warning
diff --git a/docs/public/docs/ingest.md b/docs/public/docs/ingest.md
@@ -1,3 +1,6 @@
+---
+description: Ingest
+---
 # Ingest
 
 Quesma supports the standard Elastic/OpenSearch API endpoints for ingest. Similar to Elastic/OpenSearch, the ingest process is very flexible, allowing you to ingest data without manually specifying the schema or without having to create Elastic index or ClickHouse tables prior to inserting data. Quesma can also act as a transparent proxy, allowing you to ingest data into your existing Elastic/OpenSearch cluster.
diff --git a/docs/public/docs/installation.md b/docs/public/docs/installation.md
@@ -1,3 +1,6 @@
+---
+description: Installation guide
+---
 # Installation guide
 
 The installation guide provides detailed instructions on how to set up Quesma in various scenarios. Depending on your current setup and requirements, you can follow one of the scenarios:
diff --git a/docs/public/docs/limitations.md b/docs/public/docs/limitations.md
@@ -1,3 +1,6 @@
+---
+description: Known limitations or unsupported functionalities
+---
 # Known limitations or unsupported functionalities
 
 Quesma is designed for analytical text queries such as in observability or security.
diff --git a/docs/public/docs/misc.md b/docs/public/docs/misc.md
@@ -1,3 +1,6 @@
+---
+description: Misc
+---
 ### Feedback and support
 In case of any issues, questions or feedback, please reach out to us at [support@quesma.com](mailto:support@quesma.com).
 
diff --git a/docs/public/docs/quick-start.md b/docs/public/docs/quick-start.md
@@ -1,3 +1,6 @@
+---
+description: Quick start demo
+---
 # Quick start demo
 
 The easiest way to get started is to try out the example `docker-compose` setup, which can be found in `/examples/kibana-sample-data.` It features Kibana connecting to Elasticsearch and Clickhouse through Quesma:
