[Doc] add frontmatter for Docusaurus

Signed-off-by: DanRoscigno <[email protected]>
StarRocks · Nov 16, 2023 · f82645e · f82645e
1 parent af97a24
commit f82645e
Show file tree

Hide file tree

Showing 630 changed files with 2,520 additions and 0 deletions.
diff --git a/docs/en/administration/Authentication.md b/docs/en/administration/Authentication.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Authentication methods
 
 In addition to the authentication method of "username+password", StarRocks also supports LDAP.

diff --git a/docs/en/administration/Backup_and_restore.md b/docs/en/administration/Backup_and_restore.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Backup and Recovery
 
 StarRocks supports backing up the current data as a file to a remote storage system via the broker (the broker is an optional process in the StarRocks cluster, mainly used to support StarRocks to read and write files and directories on the remote storage, please refer to the [Broker Load documentation](../loading/BrokerLoad.md). The backup data can be restored from the remote storage system to any StarRocks cluster with the restore command. This feature supports periodic snapshot backup of data. It also allows migrating data between clusters.

diff --git a/docs/en/administration/Blacklist.md b/docs/en/administration/Blacklist.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Blacklist Management
 
 In some cases, administrators need to disable certain patterns of SQL to avoid SQL from triggering cluster crashes or unexpected high concurrent queries.

diff --git a/docs/en/administration/Build_in_docker.md b/docs/en/administration/Build_in_docker.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Introduction of the dev-env image
 
 ## Download the image

diff --git a/docs/en/administration/Cluster_administration.md b/docs/en/administration/Cluster_administration.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Manage a cluster
 
 This topic explains how to manage a cluster.

diff --git a/docs/en/administration/Configuration.md b/docs/en/administration/Configuration.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Parameter Configuration
 
 After the service is started, you may adjust the configuration parameters to meet the business requirements. You need to reboot the BE and Fe to apply the changes.

diff --git a/docs/en/administration/Data_recovery.md b/docs/en/administration/Data_recovery.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Data Recovery
 
 StarRocks supports data recovery for mistakenly deleted databases/tables/partitions. After `drop table` or `drop database`, StarRocks will not physically delete the data immediately, but keep it in Trash for a period of time (1 day by default). Administrators can recover the mistakenly deleted data with the `RECOVER` command.

diff --git a/docs/en/administration/Load_balance.md b/docs/en/administration/Load_balance.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Load Balancing
 
 When deploying multiple FE nodes, users can deploy a load balancing layer on top of the  FEs to achieve high availability.

diff --git a/docs/en/administration/Memory_management.md b/docs/en/administration/Memory_management.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Memory Management
 
 This section briefly introduces memory classification and StarRocks’ methods of managing memory.

diff --git a/docs/en/administration/Metadata_recovery.md b/docs/en/administration/Metadata_recovery.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Restore FEs
 
 This topic describes how to restore the frontends (FEs) in your StarRocks cluster if the cluster is unavailable due to one of the following issues:

diff --git a/docs/en/administration/Monitor_and_Alert.md b/docs/en/administration/Monitor_and_Alert.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Monitor and Alerting
 
 You can build your own monitoring services, or use the Prometheus + Grafana solution. StarRocks provides a Prometheus-compatible interface that directly links to the HTTP port of the BE and FE to obtain monitoring information from the cluster.

diff --git a/docs/en/administration/Profiling.md b/docs/en/administration/Profiling.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Performance Optimization
 
 ## Table Creation

diff --git a/docs/en/administration/Query_management.md b/docs/en/administration/Query_management.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Query Management
 
 ## Number of user connections

diff --git a/docs/en/administration/Query_planning.md b/docs/en/administration/Query_planning.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Query analysis
 
 How to optimize query performance is a frequently asked question. Slow queries impair user experience as well as cluster performance. It is important to analyze and optimize query performance.

diff --git a/docs/en/administration/Replica.md b/docs/en/administration/Replica.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Replica management
 
 ## Terminology

diff --git a/docs/en/administration/Scale_up_down.md b/docs/en/administration/Scale_up_down.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Scale in and out
 
 This topic describes how to scale in and out the node of StarRocks.

diff --git a/docs/en/administration/User_privilege.md b/docs/en/administration/User_privilege.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # User Privilege
 
 Based on MySQL's permission management mechanism, StarRocks permission management system supports fine-grained permission control at table level, role-based access control, and whitelisting.

diff --git a/docs/en/benchmarking/SSB_Benchmarking.md b/docs/en/benchmarking/SSB_Benchmarking.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # SSB Flat-table Benchmarking
 
 Star schema benchmark (SSB) is designed to test basic performance metrics of OLAP database products. SSB uses a star schema test set that is widely applied in academia and industry. For more information, see the paper [Star Schema Benchmark](https://www.cs.umb.edu/~poneil/StarSchemaB.PDF).

diff --git a/docs/en/benchmarking/TPC-H_Benchmarking.md b/docs/en/benchmarking/TPC-H_Benchmarking.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # TPC-H Benchmarking
 
 TPC-H is a decision support benchmark developed by the Transaction Processing Performance Council (TPC). It consists of a suite of business oriented ad-hoc queries and concurrent data modifications.

diff --git a/docs/en/faq/Deploy_faq.md b/docs/en/faq/Deploy_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Deployment
 
 This topic provides answers to some frequently asked questions about deployment.

diff --git a/docs/en/faq/Exporting_faq.md b/docs/en/faq/Exporting_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Data Export
 
 ## Alibaba cloud OSS backup and restore

diff --git a/docs/en/faq/Others.md b/docs/en/faq/Others.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Others FAQs
 
 This topic provides answers to some general questions.

diff --git a/docs/en/faq/Sql_faq.md b/docs/en/faq/Sql_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # SQL
 
 This topic provides answers to some frequently asked questions about SQL.

diff --git a/docs/en/faq/loading/Broker_load_faq.md b/docs/en/faq/loading/Broker_load_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Broker Load
 
 ## In Broker Load, can a task that has already been executed successfully (State: FINISHED) be executed again?

diff --git a/docs/en/faq/loading/DataX_faq.md b/docs/en/faq/loading/DataX_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # DataX
 
 ## Why datax writer does not have writemode parameter? Why must the tables be created in the update mode?

diff --git a/docs/en/faq/loading/Flink_connector_faq.md b/docs/en/faq/loading/Flink_connector_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Flink Connector
 
 ## flink-connector-jdbc_2.11sink is 8 hours late in StarRocks

diff --git a/docs/en/faq/loading/Insert_into_faq.md b/docs/en/faq/loading/Insert_into_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Insert Into
 
 ## When performing data insert, each insert in SQL takes up 50 to 100ms. Is there any way to increase efficiency?

diff --git a/docs/en/faq/loading/Loading_faq.md b/docs/en/faq/loading/Loading_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Loading
 
 ## Common issues in loading

diff --git a/docs/en/faq/loading/Routine_load_faq.md b/docs/en/faq/loading/Routine_load_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Routine Load
 
 ## Does mysql binlog data produced by kafka count as text format data?

diff --git a/docs/en/faq/loading/Stream_load_faq.md b/docs/en/faq/loading/Stream_load_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Stream Load
 
 ## Does Stream Load identify the column name of the first row in a text file? Or can I specify the first row not to be read？

diff --git a/docs/en/introduction/StarRocks_intro.md b/docs/en/introduction/StarRocks_intro.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Introduction
 
 ## What is StarRocks

diff --git a/docs/en/loading/BrokerLoad.md b/docs/en/loading/BrokerLoad.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Broker Load
 
 StarRocks supports importing data from external storage systems such as Apache HDFS, Amazon S3, etc. The supported file formats are CSV, ORC File, Parquet, etc. The data volume is in the range of tens to hundreds of GB.

diff --git a/docs/en/loading/DataX-starrocks-writer.md b/docs/en/loading/DataX-starrocks-writer.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # DataX writer
 
 ## Introduction

diff --git a/docs/en/loading/Etl_in_loading.md b/docs/en/loading/Etl_in_loading.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # ETL When Loading
 
 When importing data into StarRocks tables, sometimes the content of the target table is **not** exactly the same as the content of the data source. For example:

diff --git a/docs/en/loading/Flink-connector-starrocks.md b/docs/en/loading/Flink-connector-starrocks.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Load data by using flink-connector-starrocks
 
 This topic describes how to load data from Apache Flink® to StarRocks.

diff --git a/docs/en/loading/Flink_cdc_load.md b/docs/en/loading/Flink_cdc_load.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Synchronize data from MySQL
 
 This topic describes how to synchronize data from MySQL to StarRocks in seconds by using Flink CDC Connector, flink-starrocks-connector, and StarRocks Migration Tools (SMT).

diff --git a/docs/en/loading/InsertInto.md b/docs/en/loading/InsertInto.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Insert Into Loading
 
 The Insert Into statement is used similarly to the Insert Into statement in databases (e.g. MySQL).

diff --git a/docs/en/loading/Json_loading.md b/docs/en/loading/Json_loading.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Introduction
 
 You can import semi-structured data (for example, JSON) by using stream load or routine load.

diff --git a/docs/en/loading/Loading_intro.md b/docs/en/loading/Loading_intro.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Data import
 
 StarRocks supports multiple data models (refer to [Table Design](../table_design/Table_design.md) chapter) for different business scenarios. The data import function aims to clean and transform the raw data according to the specific model and load it into StarRocks.

diff --git a/docs/en/loading/RoutineLoad.md b/docs/en/loading/RoutineLoad.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Routine Load
 
 The Routine load method supports continuous import of data from Kafka. Routine load can be paused, restarted, stopped by SQL. This section introduces the basic principle and usage of this method.

diff --git a/docs/en/loading/SparkLoad.md b/docs/en/loading/SparkLoad.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Spark Load
 
 Spark load uses external Spark resources to pre-process      imported data, which improves import performance and saves compute resources. It is mainly used for **initial migration** and **large data import** into StarRocks (data volume up to TB level).

diff --git a/docs/en/loading/StreamLoad.md b/docs/en/loading/StreamLoad.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Stream load
 
 StarRocks supports importing data directly from local files in CSV file format. The imported data size is up to 10GB.

diff --git a/docs/en/quick_start/Architecture.md b/docs/en/quick_start/Architecture.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Architecture
 
 ## System Architecture Diagram

diff --git a/docs/en/quick_start/Concepts.md b/docs/en/quick_start/Concepts.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Basic Concepts of StarRocks
 
 * FE: The StarRocks frontend node is responsible for metadata management, management of client connectors, query planning, query scheduling, and so on.

diff --git a/docs/en/quick_start/Data_flow_and_control_flow.md b/docs/en/quick_start/Data_flow_and_control_flow.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Data Flow and Control Flow
 
 ## Query

diff --git a/docs/en/quick_start/Deploy.md b/docs/en/quick_start/Deploy.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Deploy StarRocks
 
 Manual deployment allows users to quickly leverage StarRocks to do operation and maintenance tasks.

diff --git a/docs/en/quick_start/Import_and_query.md b/docs/en/quick_start/Import_and_query.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Data import and query
 
 ## Local File Import

diff --git a/docs/en/quick_start/Test_faq.md b/docs/en/quick_start/Test_faq.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # FAQ
 
 ## Deployment

diff --git a/docs/en/reference/Error_code.md b/docs/en/reference/Error_code.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # Error Codes
 
 This section describes the common error codes for query requests.

diff --git a/docs/en/reference/System_limit.md b/docs/en/reference/System_limit.md
@@ -1,3 +1,7 @@
+---
+displayed_sidebar: "English"
+---
+
 # System Limit
 
 This section describes rules and restrictions of  using the StarRocks system.