You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by sp...@apache.org on 2020/11/10 08:10:59 UTC
[apisix] branch master updated: fix(doc): broken links (#2682)
This is an automated email from the ASF dual-hosted git repository.
spacewander pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 9d4b418 fix(doc): broken links (#2682)
9d4b418 is described below
commit 9d4b4181c86c76100b6a8baa2712dc25991ade9c
Author: 琚致远 <ju...@apache.org>
AuthorDate: Tue Nov 10 16:10:49 2020 +0800
fix(doc): broken links (#2682)
---
CODE_OF_CONDUCT.md | 1 -
doc/README.md | 3 --
doc/_navbar.md | 22 --------
doc/_sidebar.md | 104 ------------------------------------
doc/index.html | 52 ------------------
doc/plugins/batch-requests.md | 2 +-
doc/plugins/jwt-auth.md | 2 +-
doc/plugins/prometheus.md | 2 +-
doc/plugins/proxy-cache.md | 2 +-
doc/plugins/wolf-rbac.md | 2 +-
doc/zh-cn/README.md | 2 -
doc/zh-cn/_sidebar.md | 103 -----------------------------------
doc/zh-cn/plugins/batch-requests.md | 2 +-
doc/zh-cn/plugins/jwt-auth.md | 2 +-
doc/zh-cn/plugins/prometheus.md | 2 +-
doc/zh-cn/plugins/wolf-rbac.md | 2 +-
16 files changed, 9 insertions(+), 296 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 732f5ae..3b91613 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -118,7 +118,6 @@ This statement thanks the following, on which it draws for content and inspirati
* [CouchDB Project Code of conduct](http://couchdb.apache.org/conduct.html)
* [Fedora Project Code of Conduct](http://fedoraproject.org/code-of-conduct)
- * [Speak Up! Code of Conduct](http://speakup.io/coc.html)
* [Django Code of Conduct](https://www.djangoproject.com/conduct/)
* [Debian Code of Conduct](http://www.debian.org/vote/2014/vote_002)
* [Twitter Open Source Code of Conduct](https://github.com/twitter/code-of-conduct/blob/master/code-of-conduct.md)
diff --git a/doc/README.md b/doc/README.md
index e505738..829dfaf 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -58,7 +58,6 @@
* [key-auth](plugins/key-auth.md): User authentication based on Key Authentication.
* [JWT-auth](plugins/jwt-auth.md): User authentication based on [JWT](https://jwt.io/) (JSON Web Tokens) Authentication.
* [basic-auth](plugins/basic-auth.md): User authentication based on Basic Authentication.
-* [oauth](plugins/oauth.md): Provides OAuth 2 authentication and introspection.
* [authz-keycloak](plugins/authz-keycloak.md): Authorization with Keycloak Identity Server.
* [wolf-rbac](plugins/wolf-rbac.md) User Authentication and Authorization based on *RBAC*.
* [openid-connect](plugins/openid-connect.md)
@@ -101,8 +100,6 @@
The recommended approach is to deploy APISIX with [AWS CDK](https://aws.amazon.com/cdk/) on [AWS Fargate](https://aws.amazon.com/fargate/) which helps you decouple the APISIX layer and the upstream layer on top of a fully-managed and secure serverless container compute environment with autoscaling capabilities.
-See [this guide](https://github.com/pahud/cdk-samples/blob/master/typescript/apisix/README.md) by [Pahud Hsieh](https://github.com/pahud) and learn how to provision the recommended architecture 100% in AWS CDK.
-
### Kubernetes
See [this guide](../kubernetes/README.md) and learn how to deploy apisix in Kubernetes.
diff --git a/doc/_navbar.md b/doc/_navbar.md
deleted file mode 100644
index 1612e7d..0000000
--- a/doc/_navbar.md
+++ /dev/null
@@ -1,22 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-- Translations
- - [:uk: English](/)
- - [:cn: 中文](/zh-cn/)
diff --git a/doc/_sidebar.md b/doc/_sidebar.md
deleted file mode 100644
index e627e0d..0000000
--- a/doc/_sidebar.md
+++ /dev/null
@@ -1,104 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-- Getting started
-
- - [Introduction](README.md)
- - [Quick start](getting-started.md)
-
-- General
-
- - [Architecture](architecture-design.md)
-
- - [Benchmark](benchmark.md)
-
- - Installation
-
- - [How to build](how-to-build.md)
- - [Install Dependencies](install-dependencies.md)
-
- - [HTTPS](https.md)
-
- - [Router](router-radixtree.md)
-
- - Plugins
-
- - [Develop Plugins](plugin-develop.md)
- - [Hot Reload](plugins.md)
-
- - Proxy Modes
-
- - [GRPC Proxy](grpc-proxy.md)
- - [Stream Proxy](stream-proxy.md)
-
-- Plugins
-
- - Authentication
-
- - [Key Auth](plugins/key-auth.md)
- - [Basic Auth](plugins/basic-auth.md)
- - [JWT Auth](plugins/jwt-auth.md)
- - [Opend ID Connect](plugins/openid-connect.md)
-
- - General
-
- - [Redirect](plugins/redirect.md)
- - [Serverless](plugins/serverless.md)
- - [Batch Request](plugins/batch-requests.md)
- - [Fault Injection](plugins/fault-injection.md)
- - [MQTT Proxy](plugins/mqtt-proxy.md)
- - [Proxy Cache](plugins/proxy-cache.md)
- - [Proxy Mirror](plugins/proxy-mirror.md)
- - [Echo](plugins/echo.md)
-
- - Transformations
-
- - [Response Rewrite](plugins/response-rewrite.md)
- - [Proxy Rewrite](plugins/proxy-rewrite.md)
- - [GRPC Transcoding](plugins/grpc-transcode.md)
-
- - Security
-
- - [Consumer Restriction](plugins/consumer-restriction.md)
- - [Limit Connection](plugins/limit-conn.md)
- - [Limit Count](plugins/limit-count.md)
- - [Limit Request](plugins/limit-req.md)
- - [CORS](plugins/cors.md)
- - [IP Restriction](plugins/ip-restriction.md)
- - [Referer Restriction](plugins/referer-restriction.md)
- - [Keycloak Authorization](plugins/authz-keycloak.md)
- - [RBAC Wolf](plugins/wolf-rbac.md)
-
- - Monitoring
-
- - [Prometheus](plugins/prometheus.md)
- - [SKywalking](plugins/skywalking.md)
- - [Zipkin](plugins/zipkin.md)
-
- - Loggers
-
- - [HTTP Logger](plugins/http-logger.md)
- - [Kafka Logger](plugins/kafka-logger.md)
- - [Syslog](plugins/syslog.md)
- - [TCP Logger](plugins/tcp-logger.md)
- - [UDP Logger](plugins/udp-logger.md)
-
-- Admin API
-
- - [Admin API](admin-api.md)
diff --git a/doc/index.html b/doc/index.html
deleted file mode 100644
index bf22754..0000000
--- a/doc/index.html
+++ /dev/null
@@ -1,52 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="UTF-8">
- <title>Document</title>
- <link rel="icon" href="./images/apache.png">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"/>
- <meta name="description" content="Description">
- <meta name="viewport"
- content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
- <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
- <script src="https://unpkg.com/docsify-edit-on-github/index.js"></script>
-</head>
-<body>
-<div id="app"></div>
-<script>
- window.$docsify = {
- loadSidebar: true,
- loadNavbar: true,
- mergeNavbar: true,
- maxLevel: 4,
- subMaxLevel: 2,
- name: '',
- repo: 'https://github.com/apache/apisix/',
- plugins: [
- EditOnGithubPlugin.create("https://github.com/apache/apisix/tree/master/doc/", null, "Edit of Github")
- ]
- }
-</script>
-<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
-
-</body>
-</html>
diff --git a/doc/plugins/batch-requests.md b/doc/plugins/batch-requests.md
index 7df2102..9587c03 100644
--- a/doc/plugins/batch-requests.md
+++ b/doc/plugins/batch-requests.md
@@ -45,7 +45,7 @@ None
## API
This plugin will add `/apisix/batch-requests` as the endpoint.
-You may need to use [interceptors](plugin-interceptors.md) to protect it.
+You may need to use [interceptors](../plugin-interceptors.md) to protect it.
## How To Enable
diff --git a/doc/plugins/jwt-auth.md b/doc/plugins/jwt-auth.md
index 53f60e6..c95fe0a 100644
--- a/doc/plugins/jwt-auth.md
+++ b/doc/plugins/jwt-auth.md
@@ -51,7 +51,7 @@ For more information on JWT, refer to [JWT](https://jwt.io/) for more informatio
## API
This plugin will add `/apisix/plugin/jwt/sign` to sign.
-You may need to use [interceptors](plugin-interceptors.md) to protect it.
+You may need to use [interceptors](../plugin-interceptors.md) to protect it.
## How To Enable
diff --git a/doc/plugins/prometheus.md b/doc/plugins/prometheus.md
index b07656a..1c1a7ab 100644
--- a/doc/plugins/prometheus.md
+++ b/doc/plugins/prometheus.md
@@ -30,7 +30,7 @@ none.
## API
This plugin will add `/apisix/prometheus/metrics` to expose the metrics.
-You may need to use [interceptors](plugin-interceptors.md) to protect it.
+You may need to use [interceptors](../plugin-interceptors.md) to protect it.
## How to enable it
diff --git a/doc/plugins/proxy-cache.md b/doc/plugins/proxy-cache.md
index aafc438..d818551 100644
--- a/doc/plugins/proxy-cache.md
+++ b/doc/plugins/proxy-cache.md
@@ -17,7 +17,7 @@
#
-->
-- [中文](/doc/zh-cn/plugins/proxy-cache.md)
+- [中文](../zh-cn/plugins/proxy-cache.md)
# proxy-cache
diff --git a/doc/plugins/wolf-rbac.md b/doc/plugins/wolf-rbac.md
index ec3207d..dea34c8 100644
--- a/doc/plugins/wolf-rbac.md
+++ b/doc/plugins/wolf-rbac.md
@@ -50,7 +50,7 @@ This plugin will add several API:
* /apisix/plugin/wolf-rbac/change_pwd
* /apisix/plugin/wolf-rbac/user_info
-You may need to use [interceptors](plugin-interceptors.md) to protect it.
+You may need to use [interceptors](../plugin-interceptors.md) to protect it.
## Dependencies
diff --git a/doc/zh-cn/README.md b/doc/zh-cn/README.md
index c562d10..6a2e7af 100644
--- a/doc/zh-cn/README.md
+++ b/doc/zh-cn/README.md
@@ -101,8 +101,6 @@
推荐的方法是在 [AWS Fargate](https://aws.amazon.com/fargate/) 上使用 [AWS CDK](https://aws.amazon.com/cdk/) 部署 APISIX，这有助于将 APISIX 层和上游层分离到具有自动缩放功能的完全托管和安全的无服务器容器计算环境之上。
-请参阅 [Pahud Hsieh](https://github.com/pahud) 撰写的[指南](https://github.com/pahud/cdk-samples/blob/master/typescript/apisix/README.md)，了解如何在 AWS CDK 中 100％ 配置推荐的架构。
-
### Kubernetes
请参阅[指南](../../kubernetes/README.md)并了解如何在 Kubernetes 中部署 APISIX。
diff --git a/doc/zh-cn/_sidebar.md b/doc/zh-cn/_sidebar.md
deleted file mode 100644
index 95504b6..0000000
--- a/doc/zh-cn/_sidebar.md
+++ /dev/null
@@ -1,103 +0,0 @@
-<!--
-#
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
--->
-
-- Getting started
-
- - [Introduction](./zh-cn/README.md)
- - [Quick start](./zh-cn/getting-started.md)
-
-- General
-
- - [Architecture](./zh-cn/architecture-design.md)
-
- - [Benchmark](./zh-cn/benchmark.md)
-
- - Installation
-
- - [How to build](./zh-cn/how-to-build.md)
- - [Install Dependencies](./zh-cn/install-dependencies.md)
-
- - [HTTPS](./zh-cn/https.md)
-
- - [Router](./zh-cn/router-radixtree.md)
-
- - Plugins
-
- - [Develop Plugins](./zh-cn/plugin-develop.md)
- - [Hot Reload](./zh-cn/plugins.md)
-
- - Proxy Modes
-
- - [GRPC Proxy](./zh-cn/grpc-proxy.md)
- - [Stream Proxy](./zh-cn/stream-proxy.md)
-
-- Plugins
-
- - Authentication
-
- - [Key Auth](./zh-cn/plugins/key-auth.md)
- - [Basic Auth](./zh-cn/plugins/basic-auth.md)
- - [JWT Auth](./zh-cn/plugins/jwt-auth.md)
- - [Opend ID Connect](./zh-cn/plugins/oauth.md)
-
- - General
-
- - [Redirect](./zh-cn/plugins/redirect.md)
- - [Serverless](./zh-cn/plugins/serverless.md)
- - [Batch Request](./zh-cn/plugins/batch-requests.md)
- - [Fault Injection](./zh-cn/plugins/fault-injection.md)
- - [MQTT Proxy](./zh-cn/plugins/mqtt-proxy.md)
- - [Proxy Cache](./zh-cn/plugins/proxy-cache.md)
- - [Proxy Mirror](./zh-cn/plugins/proxy-mirror.md)
- - [Echo](./zh-cn/plugins/echo.md)
-
- - Transformations
-
- - [Response Rewrite](./zh-cn/plugins/response-rewrite.md)
- - [Proxy Rewrite](./zh-cn/plugins/proxy-rewrite.md)
- - [GRPC Transcoding](./zh-cn/plugins/grpc-transcode.md)
-
- - Security
-
- - [Consumer Restriction](./zh-cn/plugins/consumer-restriction.md)
- - [Limit Connection](./zh-cn/plugins/limit-conn.md)
- - [Limit Count](./zh-cn/plugins/limit-count.md)
- - [Limit Request](./zh-cn/plugins/limit-req.md)
- - [CORS](./zh-cn/plugins/cors.md)
- - [IP Restriction](./zh-cn/plugins/ip-restriction.md)
- - [Keycloak Authorization](./zh-cn/plugins/authz-keycloak.md)
- - [RBAC Wolf](./zh-cn/plugins/wolf-rbac.md)
-
- - Monitoring
-
- - [Prometheus](./zh-cn/plugins/prometheus.md)
- - [SKywalking](./zh-cn/plugins/skywalking.md)
- - [Zipkin](./zh-cn/plugins/zipkin.md)
-
- - Loggers
-
- - [HTTP Logger](./zh-cn/plugins/http-logger.md)
- - [Kafka Logger](./zh-cn/plugins/kafka-logger.md)
- - [Syslog](./zh-cn/plugins/syslog.md)
- - [TCP Logger](./zh-cn/plugins/tcp-logger.md)
- - [UDP Logger](./zh-cn/plugins/udp-logger.md)
-
-- Admin API
-
- - [Admin API](./zh-cn/admin-api.md)
diff --git a/doc/zh-cn/plugins/batch-requests.md b/doc/zh-cn/plugins/batch-requests.md
index e73c43f..82f7d8d 100644
--- a/doc/zh-cn/plugins/batch-requests.md
+++ b/doc/zh-cn/plugins/batch-requests.md
@@ -44,7 +44,7 @@
## 接口
-插件会增加 `/apisix/batch-requests` 这个接口，你可能需要通过 [interceptors](plugin-interceptors.md)
+插件会增加 `/apisix/batch-requests` 这个接口，你可能需要通过 [interceptors](../../plugin-interceptors.md)
来保护它。
## 如何启用
diff --git a/doc/zh-cn/plugins/jwt-auth.md b/doc/zh-cn/plugins/jwt-auth.md
index f3bae24..2bf0914 100644
--- a/doc/zh-cn/plugins/jwt-auth.md
+++ b/doc/zh-cn/plugins/jwt-auth.md
@@ -51,7 +51,7 @@
## 接口
-插件会增加 `/apisix/plugin/jwt/sign` 这个接口，你可能需要通过 [interceptors](plugin-interceptors.md)
+插件会增加 `/apisix/plugin/jwt/sign` 这个接口，你可能需要通过 [interceptors](../../plugin-interceptors.md)
来保护它。
## 如何启用
diff --git a/doc/zh-cn/plugins/prometheus.md b/doc/zh-cn/plugins/prometheus.md
index 651ca14..8f89b06 100644
--- a/doc/zh-cn/plugins/prometheus.md
+++ b/doc/zh-cn/plugins/prometheus.md
@@ -29,7 +29,7 @@
## 接口
-插件会增加 `/apisix/prometheus/metrics` 这个接口，你可能需要通过 [interceptors](plugin-interceptors.md)
+插件会增加 `/apisix/prometheus/metrics` 这个接口，你可能需要通过 [interceptors](../../plugin-interceptors.md)
来保护它。
## 如何开启插件
diff --git a/doc/zh-cn/plugins/wolf-rbac.md b/doc/zh-cn/plugins/wolf-rbac.md
index a0a8030..f739a59 100644
--- a/doc/zh-cn/plugins/wolf-rbac.md
+++ b/doc/zh-cn/plugins/wolf-rbac.md
@@ -50,7 +50,7 @@ rbac功能由[wolf](https://github.com/iGeeky/wolf)提供, 有关 `wolf` 的更
* /apisix/plugin/wolf-rbac/change_pwd
* /apisix/plugin/wolf-rbac/user_info
-你可能需要通过 [interceptors](plugin-interceptors.md) 来保护它们。
+你可能需要通过 [interceptors](../../plugin-interceptors.md) 来保护它们。
## 依赖项