chore: add description meta for SEO optimization (#1348)

GreptimeTeam · Dec 4, 2024 · cd2e760 · cd2e760
1 parent 3f0610d
commit cd2e760
Show file tree

Hide file tree

Showing 425 changed files with 1,841 additions and 170 deletions.
diff --git a/docs/contributor-guide/datanode/data-persistence-indexing.md b/docs/contributor-guide/datanode/data-persistence-indexing.md
@@ -1,3 +1,7 @@
+---
+description: Explanation of data persistence and indexing in GreptimeDB, including SST file format, indexing methods, and the use of OpenDAL.
+---
+
 # Data Persistence and Indexing
 
 Similar to all LSMT-like storage engines, data in MemTables is persisted to durable storage, for example, the local disk file system or object storage service. GreptimeDB adopts [Apache Parquet][1] as its persistent file format.

diff --git a/docs/contributor-guide/datanode/metric-engine.md b/docs/contributor-guide/datanode/metric-engine.md
@@ -1,3 +1,7 @@
+---
+description: Overview of the Metric engine in GreptimeDB, its concepts, architecture, and design for handling small tables.
+---
+
 # Metric Engine
 
 ## Overview

diff --git a/docs/contributor-guide/datanode/overview.md b/docs/contributor-guide/datanode/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of Datanode in GreptimeDB, its responsibilities, components, and interaction with other parts of the system.
+---
+
 # Overview
 
 ## Introduction

diff --git a/docs/contributor-guide/datanode/python-scripts.md b/docs/contributor-guide/datanode/python-scripts.md
@@ -1,3 +1,7 @@
+---
+description: Guide on using Python scripts for data analysis in GreptimeDB, including backend options and setup instructions.
+---
+
 # Python Scripts
 
 ## Introduction

diff --git a/docs/contributor-guide/datanode/query-engine.md b/docs/contributor-guide/datanode/query-engine.md
@@ -1,3 +1,7 @@
+---
+description: Overview of GreptimeDB's query engine, its architecture, data representation, indexing, and extensibility.
+---
+
 # Query Engine
 
 ## Introduction

diff --git a/docs/contributor-guide/datanode/storage-engine.md b/docs/contributor-guide/datanode/storage-engine.md
@@ -1,3 +1,7 @@
+---
+description: Overview of the storage engine in GreptimeDB, its architecture, components, and data model.
+---
+
 # Storage Engine
 
 ## Introduction

diff --git a/docs/contributor-guide/datanode/wal.md b/docs/contributor-guide/datanode/wal.md
@@ -1,3 +1,7 @@
+---
+description: Introduction to Write-Ahead Logging (WAL) in GreptimeDB, its purpose, architecture, and operational modes.
+---
+
 # Write-Ahead Logging
 
 ## Introduction

diff --git a/docs/contributor-guide/flownode/arrangement.md b/docs/contributor-guide/flownode/arrangement.md
@@ -1,3 +1,7 @@
+---
+description: Details on the arrangement component in Flownode, which stores state and update streams for querying and updating.
+---
+
 # Arrangement
 
 Arrangement stores the state in the dataflow's process. It stores the streams of update flows for further querying and updating.

diff --git a/docs/contributor-guide/flownode/dataflow.md b/docs/contributor-guide/flownode/dataflow.md
@@ -1,3 +1,7 @@
+---
+description: Explanation of the dataflow module in Flownode, its operations, internal data handling, and future enhancements.
+---
+
 # Dataflow
 
 The `dataflow` module (see `flow::compute` module) is the core computing module of `flow`.

diff --git a/docs/contributor-guide/flownode/overview.md b/docs/contributor-guide/flownode/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of Flownode, a component providing streaming process capabilities to the database, including its components and current limitations.
+---
+
 # Overview
 
 ## Introduction

diff --git a/docs/contributor-guide/frontend/distributed-querying.md b/docs/contributor-guide/frontend/distributed-querying.md
@@ -1,3 +1,7 @@
+---
+description: Describes the process of distributed querying in GreptimeDB, focusing on the dist planner and dist plan.
+---
+
 # Distributed Querying
 
 Most steps of querying in frontend and datanode are identical. The only difference is that

diff --git a/docs/contributor-guide/frontend/overview.md b/docs/contributor-guide/frontend/overview.md
@@ -1,3 +1,7 @@
+---
+description: Provides an overview of the Frontend component in GreptimeDB, its roles, and typical deployment in the cloud.
+---
+
 # Overview
 
 The `Frontend` executes requests from clients, and performs some tasks in the cloud

diff --git a/docs/contributor-guide/frontend/table-sharding.md b/docs/contributor-guide/frontend/table-sharding.md
@@ -1,3 +1,7 @@
+---
+description: Explains how table data in GreptimeDB is sharded and distributed, including the concepts of partition and region.
+---
+
 # Table Sharding
 
 The sharding of stored data is essential to any distributed database. This document will describe how table's data in GreptimeDB is being sharded, and distributed.
@@ -48,4 +52,3 @@ The relationship between partition and region can be viewed as the following dia
 │                                  │
 └──────────────────────────────────┘
   Could be placed in one Datanode
-```
diff --git a/docs/contributor-guide/getting-started.md b/docs/contributor-guide/getting-started.md
@@ -1,3 +1,7 @@
+---
+description: Instructions for setting up and running GreptimeDB from source, including prerequisites, build dependencies, and running unit tests.
+---
+
 # Getting started
 
 This page describes how to run GreptimeDB from source in your local environment.

diff --git a/docs/contributor-guide/how-to/how-to-trace-greptimedb.md b/docs/contributor-guide/how-to/how-to-trace-greptimedb.md
@@ -1,3 +1,7 @@
+---
+description: Describes how to use Rust's tracing framework in GreptimeDB for distributed tracing, including defining tracing context in RPC, passing it, and instrumenting code.
+---
+
 # How to trace GreptimeDB
 
 GreptimeDB uses Rust's [tracing](https://docs.rs/tracing/latest/tracing/) framework for code instrument. For the specific details and usage of tracing, please refer to the official documentation of tracing.

diff --git a/docs/contributor-guide/how-to/how-to-use-tokio-console.md b/docs/contributor-guide/how-to/how-to-use-tokio-console.md
@@ -1,3 +1,7 @@
+---
+description: Guides on using tokio-console in GreptimeDB, including building with specific features and connecting to the tokio console subscriber.
+---
+
 # How to use tokio-console in GreptimeDB
 
 This document introduces how to use the [tokio-console](https://github.com/tokio-rs/console) in GreptimeDB.

diff --git a/docs/contributor-guide/how-to/how-to-write-sdk.md b/docs/contributor-guide/how-to/how-to-write-sdk.md
@@ -1,3 +1,7 @@
+---
+description: Explains how to write a gRPC SDK for GreptimeDB, focusing on the GreptimeDatabase service, its methods, and the structure of requests and responses.
+---
+
 # How to write a gRPC SDK for GreptimeDB
 
 A GreptimeDB gRPC SDK only needs to handle the writes. The reads are standard SQL and PromQL, can be handled by any JDBC

diff --git a/docs/contributor-guide/metasrv/admin-api.md b/docs/contributor-guide/metasrv/admin-api.md
@@ -1,3 +1,7 @@
+---
+description: Details the Admin API for Metasrv, including endpoints for health checks, leader queries, heartbeat data, and maintenance mode.
+---
+
 # Admin API
 
 The Admin API provides a simple way to view cluster information, including metasrv health detection, metasrv leader query, database metadata query, and datanode heartbeat detection.

diff --git a/docs/contributor-guide/metasrv/overview.md b/docs/contributor-guide/metasrv/overview.md
@@ -1,3 +1,7 @@
+---
+description: Provides an overview of the Metasrv service, its components, interactions with the Frontend, architecture, and key functionalities like distributed consensus and heartbeat management.
+---
+
 # Overview
 
 ![meta](/meta.png)

diff --git a/docs/contributor-guide/metasrv/selector.md b/docs/contributor-guide/metasrv/selector.md
@@ -1,3 +1,7 @@
+---
+description: Describes the different types of selectors in the Metasrv service, their characteristics, and how to configure them.
+---
+
 # Selector
 
 ## Introduction

diff --git a/docs/contributor-guide/overview.md b/docs/contributor-guide/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of GreptimeDB's architecture, key components, and how they interact to process user requests.
+---
+
 # Overview
 
 ## Architecture

diff --git a/docs/contributor-guide/tests/integration-test.md b/docs/contributor-guide/tests/integration-test.md
@@ -1,3 +1,7 @@
+---
+description: Guide on writing and running integration tests in GreptimeDB, covering scenarios involving multiple components.
+---
+
 # Integration Test
 
 ## Introduction

diff --git a/docs/contributor-guide/tests/overview.md b/docs/contributor-guide/tests/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of the testing methods used in GreptimeDB to ensure its behavior and performance.
+---
+
 # Overview
 
 Our team has conducted lots of tests to ensure the behaviours of `GreptimeDB` . This chapter will introduce several significant methods used to test `GreptimeDB`, and how to work with them.
diff --git a/docs/contributor-guide/tests/sqlness-test.md b/docs/contributor-guide/tests/sqlness-test.md
@@ -1,3 +1,7 @@
+---
+description: Instructions for running SQL tests in GreptimeDB using the `sqlness` test suite, including file types, case organization, and running tests.
+---
+
 # Sqlness Test
 
 ## Introduction

diff --git a/docs/contributor-guide/tests/unit-test.md b/docs/contributor-guide/tests/unit-test.md
@@ -1,3 +1,7 @@
+---
+description: Guide on writing and running unit tests in GreptimeDB using Rust's `#[test]` attribute and `cargo nextest`.
+---
+
 # Unit Test
 
 ## Introduction

diff --git a/...administration/disaster-recovery/dr-solution-based-on-active-active-failover.md b/...administration/disaster-recovery/dr-solution-based-on-active-active-failover.md
@@ -1,3 +1,7 @@
+---
+description: Detailed explanation of the active-active failover disaster recovery solution in GreptimeDB Enterprise, including read/write modes, RPO, and RTO configurations.
+---
+
 # DR Solution Based on Active-Active Failover
 
 ## RPO

diff --git a/docs/enterprise/administration/disaster-recovery/overview.md b/docs/enterprise/administration/disaster-recovery/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of disaster recovery solutions in GreptimeDB Enterprise, focusing on the active-active failover architecture for high availability and data protection.
+---
+
 # Overview
 
 GreptimeDB is a distributed database designed to withstand disasters.

diff --git a/docs/enterprise/autopilot/region-balancer.md b/docs/enterprise/autopilot/region-balancer.md
@@ -1,3 +1,7 @@
+---
+description: Configuration guide for the region balancer plugin in GreptimeDB Enterprise, which balances write loads across datanodes to prevent frequent region migrations.
+---
+
 # Region Balancer
 
 This plugin balances the write load of regions across datanodes, using specified window sizes and load thresholds to prevent frequent region migrations.

diff --git a/docs/enterprise/deployments/audit-logging.md b/docs/enterprise/deployments/audit-logging.md
@@ -1,3 +1,7 @@
+---
+description: Guide to configuring audit logging in GreptimeDB Enterprise, including examples and configuration options to monitor and record database activities.
+---
+
 # Audit Logging
 
 Database audit logging is the process of recording the actions performed on the database. The audit logs help monitor

diff --git a/docs/enterprise/deployments/authentication.md b/docs/enterprise/deployments/authentication.md
@@ -1,3 +1,7 @@
+---
+description: Configuration guide for LDAP authentication in GreptimeDB Enterprise, detailing both simple bind and search bind modes.
+---
+
 # LDAP Authentication
 
 In addition to the built-in [static user provider](/user-guide/deployments/authentication/static.md) in GreptimeDB OSS,

diff --git a/docs/enterprise/overview.md b/docs/enterprise/overview.md
@@ -1,3 +1,7 @@
+---
+description: Overview of GreptimeDB Enterprise, detailing its advanced features, solutions, and enhancements over the open-source version to optimize data efficiency and reduce costs.
+---
+
 # Overview
 
 GreptimeDB Enterprise is a powerful time-series database solution designed to meet the specific needs of enterprises.

diff --git a/docs/enterprise/release-notes/release-24_11.md b/docs/enterprise/release-notes/release-24_11.md
@@ -1,3 +1,7 @@
+---
+description: Release notes for GreptimeDB Enterprise version 24.11, highlighting new features like region rebalancing, management console, LDAP user provider, and audit logs.
+---
+
 # Release 24.11
 
 We are pleased to introduce the 24.11 release of GreptimeDB Enterprise.

diff --git a/docs/faq-and-others/faq.md b/docs/faq-and-others/faq.md
@@ -1,3 +1,7 @@
+---
+description: Frequently Asked Questions about GreptimeDB, covering use cases, performance, compatibility, features, and more.
+---
+
 # Frequently Asked Questions
 
 ### What would be the use cases for a time-series database?

diff --git a/docs/getting-started/installation/greptimedb-cluster.md b/docs/getting-started/installation/greptimedb-cluster.md
@@ -1,3 +1,7 @@
+---
+description: Instructions to deploy GreptimeDB in cluster mode using Kubernetes or Docker Compose, including steps for setup and cleanup.
+---
+
 # GreptimeDB Cluster
 
 The GreptimeDB cluster can run in cluster mode to scale horizontally.

diff --git a/docs/getting-started/installation/greptimedb-dashboard.md b/docs/getting-started/installation/greptimedb-dashboard.md
@@ -1,3 +1,7 @@
+---
+description: Information on accessing and using the GreptimeDB Dashboard for visualizing time series data.
+---
+
 # GreptimeDB Dashboard
 
 Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard).

diff --git a/docs/getting-started/installation/greptimedb-standalone.md b/docs/getting-started/installation/greptimedb-standalone.md
@@ -1,3 +1,7 @@
+---
+description: Guide to install and run GreptimeDB in standalone mode using binary or Docker, including binding address configuration.
+---
+
 # GreptimeDB Standalone
 
 We use the simplest configuration for you to get started. For a comprehensive list of configurations available in GreptimeDB, see the [configuration documentation](/user-guide/deployments/configuration.md).

diff --git a/docs/getting-started/installation/overview.md b/docs/getting-started/installation/overview.md
@@ -1,3 +1,7 @@
+---
+description: Instructions to install GreptimeDB, check its health status, and proceed to the quick start guide.
+---
+
 # Overview
 
 ## Installation

diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md
@@ -1,3 +1,7 @@
+---
+description: A guide to quickly start with GreptimeDB, including connecting to the database, creating tables, inserting data, querying data, and using the GreptimeDB dashboard.
+---
+
 # Quick Start
 
 Before proceeding, please ensure you have [installed GreptimeDB](./installation/overview.md).

diff --git a/docs/greptimecloud/getting-started/go.md b/docs/greptimecloud/getting-started/go.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Go, and visualizing data in GreptimeDB.
+---
+
 # Go
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/influxdb.md b/docs/greptimecloud/getting-started/influxdb.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using InfluxDB Line Protocol, and visualizing data in GreptimeDB.
+---
+
 # InfluxDB Line Protocol
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/java.md b/docs/greptimecloud/getting-started/java.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Java, and visualizing data in GreptimeDB.
+---
+
 # Java
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/mysql.md b/docs/greptimecloud/getting-started/mysql.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using MySQL, and visualizing data in GreptimeDB.
+---
+
 # MySQL
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/node.md b/docs/greptimecloud/getting-started/node.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Node.js, and visualizing data in GreptimeDB.
+---
+
 # Node.js
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/prometheus.md b/docs/greptimecloud/getting-started/prometheus.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Prometheus, and visualizing data in GreptimeDB.
+---
+
 # Prometheus
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/python.md b/docs/greptimecloud/getting-started/python.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Python, and visualizing data in GreptimeDB.
+---
+
 # Python
 
 ## Create Service

diff --git a/docs/greptimecloud/getting-started/vector.md b/docs/greptimecloud/getting-started/vector.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on creating a service, writing data using Vector, and visualizing data in GreptimeDB.
+---
+
 # Vector
 
 ## Create Service

diff --git a/docs/greptimecloud/integrations/alloy.md b/docs/greptimecloud/integrations/alloy.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on integrating GreptimeCloud with Grafana Alloy for Prometheus Remote Write and OpenTelemetry.
+---
+
 # Alloy
 
 [Grafana Alloy](https://grafana.com/docs/alloy/latest/) is an observability data pipeline as well as an OpenTelemetry

diff --git a/docs/greptimecloud/integrations/dbeaver.md b/docs/greptimecloud/integrations/dbeaver.md
@@ -1,3 +1,7 @@
+---
+description: Guide on using DBeaver to connect to GreptimeCloud via MySQL database drivers.
+---
+
 # DBeaver
 
 [DBeaver](https://dbeaver.io/) is a free, open-source, and cross-platform database tool that supports all popular databases. It is a popular choice among developers and database administrators for its ease of use and extensive feature set.

diff --git a/docs/greptimecloud/integrations/emqx.md b/docs/greptimecloud/integrations/emqx.md
@@ -1,3 +1,7 @@
+---
+description: Instructions on configuring GreptimeCloud as a data sink in EMQX Platform for IoT data ingestion.
+---
+
 # EMQX Platform
 
 [EMQX Platform](https://www.emqx.io/) is an MQTT Gateway, designed to handle