Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: lint Markdown #3178

Merged
merged 1 commit into from
Jan 6, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ MD007: false
MD010: false
MD013: false
MD014: false
MD022: false
MD024: false
MD026: false
MD029: false
Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
- fix: check decrypt key to prevent lua thread aborted [#2815](https://github.com/apache/apisix/pull/2815)

## Not downward compatible features in future versions

-In the 2.3 release, the consumer will only support user names and discard the id. The consumer needs to manually clean up the id field in etcd, otherwise the schema verification will report an error during use
-In the 2.3 release, opening websocket on upstream will no longer be supported
-In version 3.0, the data plane and control plane will be separated into two independent ports, that is, the current port 9080 will only process data plane requests, and no longer process admin API requests
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@
- 实现完成 `sys logger` 插件. [#1414](https://github.com/apache/incubator-apisix/pull/1414)

## 1.2.0

1.2 版本在内核以及插件上带来了非常多的更新。

### Core
Expand Down Expand Up @@ -341,6 +342,7 @@
- 使用 `lua-resty-jsonschema` 全局替换 `lua-rapidjson` 扩展,`lua-resty-jsonschema` 解析速度更快,更容易编译。

## 0.8.0

> Released on 2019/09/30

这个版本带来很多新的特性,比如四层协议的代理, 支持 MQTT 协议代理,以及对 ARM 平台的支持, 和代理改写插件等。
Expand Down
1 change: 1 addition & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ Server: APISIX web server
```

## How to fix OpenResty Installation Failure on MacOS 10.15

When you install the OpenResty on MacOs 10.15, you may face this error

```shell
Expand Down
4 changes: 4 additions & 0 deletions doc/plugins/batch-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| max_body_size | integer | required | 1048576 | > 0 | the maximum of request body size in bytes |

## Batch API Request/Response

The plugin will create a API in `apisix` to handle your batch request.

### Batch API Request:
Expand All @@ -82,6 +83,7 @@ The plugin will create a API in `apisix` to handle your batch request.
| pipeline | [HttpRequest](#HttpRequest) | required | | | Request's detail |

#### HttpRequest

| Name | Type | Requirement | Default | Valid | Description |
| ---------- | ------- | ----------- | ------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| version | string | optional | 1.1 | [1.0, 1.1] | http version |
Expand All @@ -93,9 +95,11 @@ The plugin will create a API in `apisix` to handle your batch request.
| ssl_verify | boolean | optional | false | | verify if SSL cert matches hostname. |

### Batch API Response:

Response is `Array` of [HttpResponse](#HttpResponse).

#### HttpResponse

| Name | Type | Description |
| ------- | ------- | --------------------- |
| status | integer | http status code |
Expand Down
1 change: 1 addition & 0 deletions doc/plugins/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The OAuth 2 / Open ID Connect(OIDC) plugin provides authentication and introspec
| set_userinfo_header | boolean | optional | true | | Whether to ensure the UserInfo object, if available, is set in the `X-Userinfo` request header. |

### Modes of operation

The plugin supports different modes of operation.

1) It can be configured to just validate an access token that is expected to be present in a request header.
Expand Down
7 changes: 7 additions & 0 deletions doc/powered-by.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,20 +57,27 @@ Users are encouraged to add themselves to this page, [issue](https://github.com/
<img src="https://raw.githubusercontent.com/iresty/iresty.com/master/user-wall.jpg" width="900" height="500">

# User Cases

## NASA JPL

Using Apache APISIX as a API gateway to deal with north-south and east-west traffic between microservices.

## ke.com

Using Apache APISIX as traffic entry gateway

## meizu

Using Apache APISIX as api gateway (limit, grpc transcode, abtest, dynamic configures ...)

## zuzuche.com

Using Apache APISIX as a gateway, it uses the functions of current limiting, speed limiting, black-and-white list and so on. In the later stage, it also wants to add gRPC protocol, Serverless, custom plug-in, and other functions to meet business needs.

## souche.com

Using Apache APISIX as a Web ACL gateway to deal with backend OA systems traffic.

## HelloTalk, Inc.

Using Apache APISIX as an API gateway to manage all API and SSL certificates in test\dev\CMS environment.
1 change: 1 addition & 0 deletions doc/router-radixtree.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
# libradixtree

### what's libradixtree?

[libradixtree](https://github.com/iresty/lua-resty-radixtree), adaptive radix trees implemented in Lua for OpenResty.

APISIX using libradixtree as route dispatching library.
Expand Down
4 changes: 4 additions & 0 deletions doc/zh-cn/plugins/batch-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| max_body_size | integer | 必选 | 1048576 | > 0 | 请求体的最大大小,单位为字节。|

## 批量接口请求/响应

插件会为 `apisix` 创建一个 `/apisix/batch-requests` 的接口来处理你的批量请求。

### 接口请求参数:
Expand All @@ -81,6 +82,7 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| pipeline | [HttpRequest](#HttpRequest) | 必须 | | | Http 请求的详细信息 |

#### HttpRequest

| 参数名 | 类型 | 可选 | 默认值 | 有效值 | 描述 |
| ---------- | ------- | ---- | ------ | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| version | string | 可选 | 1.1 | [1.0, 1.1] | 请求用的 `http` 协议版本 |
Expand All @@ -92,9 +94,11 @@ curl http://127.0.0.1:9080/apisix/admin/plugin_metadata/batch-requests -H 'X-API
| ssl_verify | boolean | 可选 | false | | 验证 SSL 证书与主机名是否匹配 |

### 接口响应参数:

返回值为一个 [HttpResponse](#HttpResponse) 的 `数组`。

#### HttpResponse

| 参数名 | 类型 | 描述 |
| ------- | ------- | ------------------- |
| status | integer | Http 请求的状态码 |
Expand Down
1 change: 1 addition & 0 deletions doc/zh-cn/plugins/consumer-restriction.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ HTTP/1.1 403 Forbidden
```

### 如何限制 `service_id`

`service_id`方式需要与授权插件一起配合使用,这里以key-auth授权插件为例。

1、创建两个 service
Expand Down
1 change: 1 addition & 0 deletions doc/zh-cn/plugins/sls-logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
|buffer_duration|可选的 |必须先处理批次中最旧条目的最大期限(以秒为单位)。|
|max_retry_count|可选的 |从处理管道中移除之前的最大重试次数。|
|retry_delay |可选的 |如果执行失败,应该延迟进程执行的秒数。|

## 如何开启

1. 下面例子展示了如何为指定路由开启 `sls-logger` 插件的。
Expand Down
2 changes: 2 additions & 0 deletions kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# limitations under the License.
#
-->

### kubernetes

There are some yaml files for deploying apisix in Kubernetes.
Expand All @@ -35,6 +36,7 @@ $ kubectl create configmap apisix-gw-config.yaml --from-file=../conf/config.yaml
```

#### when using etcd-operator

when using etcd-operator, you need to change `apisix-gw-config-cm.yaml`:

* add CoreDNS IP into dns_resolver
Expand Down