docs: Added title to markdown under docs (#3685)

apache · Feb 26, 2021 · 9c5ba91 · 9c5ba91
1 parent 12fb8eb
commit 9c5ba91
Show file tree

Hide file tree

Showing 134 changed files with 629 additions and 176 deletions.
diff --git a/docs/en/latest/admin-api.md b/docs/en/latest/admin-api.md
@@ -1,3 +1,7 @@
+---
+title: Admin API
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# Table of Contents
+## Table of Contents
 
 * [Route](#route)
 * [Service](#service)

diff --git a/docs/en/latest/architecture-design.md b/docs/en/latest/architecture-design.md
@@ -1,3 +1,7 @@
+---
+title: Architecture Design
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/aws.md b/docs/en/latest/aws.md
@@ -1,3 +1,7 @@
+---
+title: Running APISIX in AWS with AWS CDK
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Running APISIX in AWS with AWS CDK
-
 [APISIX](https://github.com/apache/apisix) is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.
 
 ## Architecture

diff --git a/docs/en/latest/batch-processor.md b/docs/en/latest/batch-processor.md
@@ -1,3 +1,7 @@
+---
+title: Batch Processor
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Batch Processor
-
 The batch processor can be used to aggregate entries(logs/any data) and process them in a batch.
 When the batch_max_size is set to zero the processor will execute each entry immediately. Setting the batch max size more
 than 1 will start aggregating the entries until it reaches the max size or the timeout expires.

diff --git a/docs/en/latest/benchmark.md b/docs/en/latest/benchmark.md
@@ -1,3 +1,7 @@
+---
+title: Benchmark
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/control-api.md b/docs/en/latest/control-api.md
@@ -1,3 +1,7 @@
+---
+title: Control API
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/customize-nginx-configuration.md b/docs/en/latest/customize-nginx-configuration.md
@@ -1,3 +1,7 @@
+---
+title: Customize Nginx configuration
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Customize Nginx configuration
-
 The Nginx configuration used by APISIX is generated via the template file `apisix/ngx_tpl.lua` and the options from `conf/config-default.yaml` / `conf/config.yaml`.
 
 You can take a look at the generated Nginx configuration in `conf/nginx.conf` after running `./bin/apisix start`.

diff --git a/docs/en/latest/debug-function.md b/docs/en/latest/debug-function.md
@@ -1,3 +1,7 @@
+---
+title: Debug Function
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/discovery.md b/docs/en/latest/discovery.md
@@ -1,3 +1,7 @@
+---
+title: Integration service discovery registry
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Integration service discovery registry
-
 * [**Summary**](#summary)
 * [**Supported discovery registries**](#supported-discovery-registries)
 * [**How to extend the discovery client?**](#how-to-extend-the-discovery-client)

diff --git a/docs/en/latest/discovery/consul_kv.md b/docs/en/latest/discovery/consul_kv.md
@@ -1,3 +1,7 @@
+---
+title: consul_kv
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/dns.md b/docs/en/latest/dns.md
@@ -1,3 +1,7 @@
+---
+title: DNS
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/examples/plugins-hmac-auth-generate-signature.md b/docs/en/latest/examples/plugins-hmac-auth-generate-signature.md
@@ -1,3 +1,7 @@
+---
+title: HMAC Generate Signature Examples
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# HMAC Generate Signature Examples
-
 ## Python 3
 
 ```python

diff --git a/docs/en/latest/getting-started.md b/docs/en/latest/getting-started.md
@@ -1,3 +1,7 @@
+---
+title: Getting Started
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# Quick Start Guide
+## Quick Start Guide
 
 The goal of this guide is to get started with APISIX and to configure a secured public API with APISIX.
 By the end of this guide, you will have a working APISIX setup and a new service which will route to a public API, which is secured by an API key.

diff --git a/docs/en/latest/grpc-proxy.md b/docs/en/latest/grpc-proxy.md
@@ -1,3 +1,7 @@
+---
+title: grpc-proxy
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# grpc-proxy
-
 proxying gRPC traffic:
 gRPC client -> APISIX -> gRPC/gRPCS server
 

diff --git a/docs/en/latest/health-check.md b/docs/en/latest/health-check.md
@@ -1,3 +1,7 @@
+---
+title: Health Check
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# Health Checks for Upstream
+## Health Checks for Upstream
 
 Health Check of APISIX is based on [lua-resty-healthcheck](https://github.com/Kong/lua-resty-healthcheck),
 you can use it for upstream.

diff --git a/docs/en/latest/how-to-build.md b/docs/en/latest/how-to-build.md
@@ -1,3 +1,7 @@
+---
+title: Build Apache APISIX
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Build Apache APISIX
-
 ## 1. Install dependencies
 
 The runtime environment for Apache APISIX requires Nginx and etcd.

diff --git a/docs/en/latest/https.md b/docs/en/latest/https.md
@@ -1,3 +1,7 @@
+---
+title: HTTPS
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-### HTTPS
-
 `APISIX` supports to load multiple SSL certificates by TLS extension Server Name Indication (SNI).
 
 ### Single SNI

diff --git a/docs/en/latest/install-dependencies.md b/docs/en/latest/install-dependencies.md
@@ -1,3 +1,7 @@
+---
+title: Install Dependencies
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-# Install Dependencies
-
 - [Install Dependencies](#install-dependencies)
 - [Note](#note)
 - [CentOS 7](#centos-7)
@@ -27,7 +29,7 @@
 - [Debian 9 & 10](#debian-9--10)
 - [Mac OSX](#mac-osx)
 
-# Note
+## Note
 
 - Since v2.0 Apache APISIX would not support the v2 protocol storage to etcd anymore, and the minimum etcd version supported is v3.4.0. What's more, etcd v3 uses gRPC as the messaging protocol, while Apache APISIX uses HTTP(S) to communicate with etcd cluster, so be sure the [etcd gRPC gateway](https://etcd.io/docs/v3.4.0/dev-guide/api_grpc_gateway/) is enabled.
 
@@ -41,7 +43,7 @@
 
 - WARNING: If you are using OpenResty which is older than `1.17.8`, please installing openresty-openss-devel instead of openresty-openssl111-devel.
 
-# CentOS 7
+## CentOS 7
 
 ```shell
 # install etcd
@@ -64,7 +66,7 @@ curl https://raw.githubusercontent.com/apache/apisix/master/utils/linux-install-
 nohup etcd &
 ```
 
-# Fedora 31 & 32
+## Fedora 31 & 32
 
 ```shell
 # add OpenResty source
@@ -87,7 +89,7 @@ curl https://raw.githubusercontent.com/apache/apisix/master/utils/linux-install-
 nohup etcd &
 ```
 
-# Ubuntu 16.04 & 18.04
+## Ubuntu 16.04 & 18.04
 
 ```shell
 # add OpenResty source
@@ -113,7 +115,7 @@ curl https://raw.githubusercontent.com/apache/apisix/master/utils/linux-install-
 nohup etcd &
 ```
 
-# Debian 9 & 10
+## Debian 9 & 10
 
 ```shell
 # optional
@@ -144,7 +146,7 @@ curl https://raw.githubusercontent.com/apache/apisix/master/utils/linux-install-
 nohup etcd &
 ```
 
-# Mac OSX
+## Mac OSX
 
 ```shell
 # install OpenResty, etcd and some compilation tools

diff --git a/docs/en/latest/mtls.md b/docs/en/latest/mtls.md
@@ -1,3 +1,7 @@
+---
+title: Mutual TLS authentication
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-## Mutual TLS authentication
-
 ### Why use it
 
 Mutual TLS authentication provides a better way to prevent unauthorized access to APISIX.

diff --git a/docs/en/latest/plugin-develop.md b/docs/en/latest/plugin-develop.md
@@ -1,3 +1,7 @@
+---
+title: Plugin Develop
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# table of contents
+## table of contents
 
 - [**where to put your plugins**](#where-to-put-your-plugins)
 - [**check dependencies**](#check-dependencies)

diff --git a/docs/en/latest/plugin-interceptors.md b/docs/en/latest/plugin-interceptors.md
@@ -1,3 +1,7 @@
+---
+title: Plugin interceptors
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,8 +21,6 @@
 #
 -->
 
-## Plugin interceptors
-
 Some plugins will register API to serve their purposes.
 
 Since these API are not added as regular [Route](admin-api.md), we can't add

diff --git a/docs/en/latest/plugins.md b/docs/en/latest/plugins.md
@@ -1,3 +1,7 @@
+---
+title: Plugins
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more

diff --git a/docs/en/latest/plugins/api-breaker.md b/docs/en/latest/plugins/api-breaker.md
@@ -1,3 +1,7 @@
+---
+title: api-breaker
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# Summary
+## Summary
 
 - [**Name**](#name)
 - [**Attributes**](#attributes)

diff --git a/docs/en/latest/plugins/authz-keycloak.md b/docs/en/latest/plugins/authz-keycloak.md
@@ -1,3 +1,7 @@
+---
+title: authz-keycloak
+---
+
 <!--
 #
 # Licensed to the Apache Software Foundation (ASF) under one or more
@@ -17,7 +21,7 @@
 #
 -->
 
-# Summary
+## Summary
 
 - [**Name**](#name)
 - [**Attributes**](#attributes)