Skip to content
Permalink
Browse files
docs: lint Markdown for multiple consecutive blank lines (#3047)
- remove unneeded MD009 - Trailing spaces config entry
- MD012 - Multiple consecutive blank lines

https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md012---multiple-consecutive-blank-lines
  • Loading branch information
jbampton committed Dec 17, 2020
1 parent f476d2c commit 1f52c70d841b790a0e4617a3daf53ea3f5b7cdd0
Showing 54 changed files with 0 additions and 136 deletions.
@@ -22,10 +22,8 @@ MD004: false
MD005: false
MD006: false
MD007: false
MD009: false
MD010: false
MD011: false
MD012: false
MD013: false
MD014: false
MD018: false
@@ -139,13 +139,11 @@ For more changes, please refer to [Milestone](https://github.com/apache/apisix/m
- doc: fixed `grpc-transcode` plugin path error in `README`. [1946](https://github.com/apache/apisix/pull/1946)
- doc: removed unnecessary configurations for `k8s` document. [1891](https://github.com/apache/apisix/pull/1891)


## 1.4.1

### Bugfix
- Fix: multiple SSL certificates are configured, but only one certificate working fine. [1818](https://github.com/apache/incubator-apisix/pull/1818)


## 1.4.0

### Core
@@ -163,7 +161,6 @@ For more changes, please refer to [Milestone](https://github.com/apache/apisix/m
- SSL private key encryption [1678](https://github.com/apache/incubator-apisix/pull/1678)
- Improvement of docs for multiple plugins


## 1.3.0

The 1.3 version is mainly for security update.
@@ -176,7 +173,6 @@ The 1.3 version is mainly for security update.
- :sunrise: **add batch request plugin**. [#1388](https://github.com/apache/incubator-apisix/pull/1388)
- implemented plugin `sys logger`. [#1414](https://github.com/apache/incubator-apisix/pull/1414)


## 1.2.0

The 1.2 version brings many new features, including core and plugins.
@@ -216,7 +212,6 @@ The 1.2 version brings many new features, including core and plugins.
- the plugin basic-auth needs required field. [#1251](https://github.com/apache/incubator-apisix/pull/1251)
- check the count of upstream valid node. [#1292](https://github.com/apache/incubator-apisix/pull/1292)


## 1.1.0

This release is mainly to strengthen the stability of the code and add more documentation.
@@ -33,7 +33,6 @@
- [0.7.0](#070)
- [0.6.0](#060)


## 2.1.0

### Core
@@ -140,7 +139,6 @@
- 文档:修正 `README``grpc-transcode` 文档路径。[1946](https://github.com/apache/apisix/pull/1946)
- 文档: 删除 `k8s` 文档中不必要的配置。[1891](https://github.com/apache/apisix/pull/1891)


## 1.4.1

### Bugfix
@@ -175,7 +173,6 @@
- :sunrise: **新增 batch request 插件**. [#1388](https://github.com/apache/incubator-apisix/pull/1388)
- 实现完成 `sys logger` 插件. [#1414](https://github.com/apache/incubator-apisix/pull/1414)


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

@@ -214,7 +211,6 @@
- basic-auth 增加 required 字段. [#1251](https://github.com/apache/incubator-apisix/pull/1251)
- 检查上游合法节点的个数. [#1292](https://github.com/apache/incubator-apisix/pull/1292)


## 1.1.0

这个版本主要是加强代码的稳定性,以及增加更多的文档。
@@ -249,7 +245,6 @@
- 增加 wolf-rbac 插件。 [#1095](https://github.com/apache/incubator-apisix/pull/1095)
- 增加 udp-logger 插件。 [#1070](https://github.com/apache/incubator-apisix/pull/1070)


## 1.0.0

这个版本主要是加强代码的稳定性,以及增加更多的文档。
@@ -287,7 +282,6 @@
- 安装程序增加了仪表盘开关,支持用户自主选择是否安装仪表板程序。 [#686](https://github.com/apache/incubator-apisix/pull/686)
- 取消对 R3 路由的支持,并移除 R3 路由模块。 [#725](https://github.com/apache/incubator-apisix/pull/725)


### Plugins
- :sunrise: **[Redirect URI](https://github.com/apache/incubator-apisix/blob/master/doc/plugins/redirect.md)**: URI 重定向插件。 [#732](https://github.com/apache/incubator-apisix/pull/732)
- [Proxy Rewrite](https://github.com/apache/incubator-apisix/blob/master/doc/plugins/proxy-rewrite.md):支持 `header` 删除功能。 [#658](https://github.com/apache/incubator-apisix/pull/658)
@@ -308,11 +302,9 @@
- 在APISIX CLI中跳过 luajit 环境的`check cjson`。[#652](https://github.com/apache/incubator-apisix/pull/652)
- 配置 `Upstream` 时,选择 `balancer` 类型为 `chash` 时,支持更多Nginx内置变量作为计算key。 [#775](https://github.com/apache/incubator-apisix/pull/775)


### Dependencies
- 使用 `lua-resty-jsonschema` 全局替换 `lua-rapidjson` 扩展,`lua-resty-jsonschema` 解析速度更快,更容易编译。


## 0.8.0
> Released on 2019/09/30
@@ -341,7 +333,6 @@
- 允许设置用户自定义函数来做额外的过滤。
- 使用 `lua-resty-ipmatcher` 替代 `lua-resty-iputils`, `lua-resty-ipmatcher` 支持 IPv6 并且速度更快。


### Bugfix
- 健康检查: 修复在多 worker 下运行时健康检查 checker 的名字错误。 [#568](https://github.com/apache/incubator-apisix/issues/568)

@@ -376,10 +367,8 @@
### Dashboard
- :sunrise: **增加在线版本的 dashboard**,用户不用安装即可[体验 APISIX](http://apisix.iresty.com/). [#374](https://github.com/apache/incubator-apisix/issues/374)


[Back to TOC](#table-of-contents)


## 0.6.0

> Released on 2019/08/05
@@ -44,7 +44,6 @@ it can enrich all of us and the technical communities in which we participate.

We strive to:


1. __Be open.__ We invite anyone to participate in our community. We preferably use public methods of communication for project-related messages, unless discussing something sensitive. This applies to messages for help or project-related support, too; not only is a public support request much more likely to result in an answer to a question, it also makes sure that any inadvertent mistakes made by people answering will be more easily detected and corrected.

2. __Be `empathetic`, welcoming, friendly, and patient.__ We work together to resolve conflict, assume good intentions, and do our best to act in an empathetic fashion. We may all experience some frustration from time to time, but we do not allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one. We should be respectful when dealing with other community members as well as with people outside our community.
@@ -74,7 +73,6 @@ We strive to:

7. __Step down considerately.__ Members of every project come and go. When somebody leaves or disengages from the project they should tell people they are leaving and take the proper steps to ensure that others can pick up where they left off. In doing so, they should remain respectful of those who continue to participate in the project and should not misrepresent the project's goals or achievements. Likewise, community members should respect any individual's choice to leave the project.</p>


## Diversity Statement ##

Apache welcomes and encourages participation by everyone. We are committed to being a community that everyone feels good about joining. Although we may not be able to satisfy everyone, we will always work to treat everyone well.
@@ -107,15 +105,12 @@ or one of our volunteers:

If the violation is in documentation or code, for example inappropriate pronoun usage or word choice within official documentation, we ask that people report these privately to the project in question at private@<em>project</em>.apache.org, and, if they have sufficient ability within the project, to resolve or remove the concerning material, being mindful of the perspective of the person originally reporting the issue.


## End Notes ##

This Code defines __empathy__ as "a vicarious participation in the emotions, ideas, or opinions of others; the ability to imagine oneself in the condition or predicament of another." __Empathetic__ is the adjectival form of empathy.


This statement thanks the following, on which it draws for content and inspiration:


* [CouchDB Project Code of conduct](http://couchdb.apache.org/conduct.html)
* [Fedora Project Code of Conduct](http://fedoraproject.org/code-of-conduct)
* [Django Code of Conduct](https://www.djangoproject.com/conduct/)
@@ -37,7 +37,6 @@ for us to fix.

* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/apache/apisix/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.


## How to add a new feature or change an existing one

_Before making any significant changes, please [open an issue](https://github.com/apache/apisix/issues)._ Discussing your proposed changes ahead of time will make the contribution process smooth for everyone.
2 FAQ.md
@@ -107,7 +107,6 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335
}'
```


Here is the operator list of current `lua-resty-radixtree`
https://github.com/iresty/lua-resty-radixtree#operator-list

@@ -192,7 +191,6 @@ Server: APISIX web server
</html>
```


## How to fix OpenResty Installation Failure on MacOS 10.15
When you install the OpenResty on MacOs 10.15, you may face this error

@@ -23,7 +23,6 @@

微服务领域对 API 网关有新的需求:更高的灵活性、更高的性能要求,以及云原生的贴合。


## APISIX 和其他的 API 网关有什么不同之处?

APISIX 基于 etcd 来完成配置的保存和同步,而不是 postgres 或者 MySQL 这类关系型数据库。
@@ -110,7 +109,6 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335
}'
```


更多的 lua-resty-radixtree 匹配操作,可查看操作列表:
https://github.com/iresty/lua-resty-radixtree#operator-list

@@ -294,7 +294,6 @@ Using AWS's 8 core server, APISIX's QPS reach to 140,000 with a latency of only

Benchmark comparison test [details data](https://gist.github.com/membphis/137db97a4bf64d3653aa42f3e016bd01)


## Community

- Mailing List: Mail to dev-subscribe@apisix.apache.org, follow the reply to subscribe the mailing list.
@@ -292,7 +292,6 @@ CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubun

性能对比测试[详细内容如下](https://gist.github.com/membphis/137db97a4bf64d3653aa42f3e016bd01)。


## 社区

- 邮件列表 - 发送任意内容到 dev-subscribe@apisix.apache.org 后,根据回复以订阅邮件列表。
@@ -555,7 +555,6 @@ In addition to the basic complex equalization algorithm selection, APISIX's Upst
|create_time|optional| epoch timestamp in second, like `1602883670`, will be created automatically if missing|
|update_time|optional| epoch timestamp in second, like `1602883670`, will be created automatically if missing|


Config Example:

```shell
@@ -21,8 +21,6 @@

[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

This reference architecture walks you through building **APISIX** as a serverless container API Gateway on top of AWS Fargate with AWS CDK.
@@ -167,8 +165,6 @@ new ApiSixStack(app, 'apisix-stack-dev', { env: devEnv });
app.synth();
```



## Deploy the APISIX Stack with AWS CDK

```bash
@@ -210,7 +206,6 @@ Address: 44.226.102.63

Configure the IP addresses returned as your upstream nodes in your **APISIX** dashboard followed by the **Services** and **Routes** configuration. Let's say we have a `/index.php` as the URI for the first route for our first **Service** from the **Upstream** IP addresses.


![](images/aws-nlb-ip-addr.png)
![](images/aws-define-service.png)
![](images/aws-define-route.png)
@@ -229,7 +224,6 @@ Now we have been successfully running **APISIX** in AWS Fargate as serverless co
$ cdk destroy
```


## Running APISIX in AWS China Regions

update `src/main.ts`
@@ -246,10 +240,8 @@ update `src/main.ts`
```
_(read [here](https://github.com/iresty/docker-apisix/blob/9a731f698171f4838e9bc0f1c05d6dda130ca89b/example/docker-compose.yml#L18-L19) for more reference)_


Run `cdk deploy` and specify your preferred AWS region in China.


```bash
# let's say we have another AWS_PROFILE for China regions called 'cn'
# make sure you have aws configure --profile=cn properly.
@@ -271,7 +263,6 @@ apiSix.ApiSixServiceServiceURLF6EC7872 = http://apiSi-ApiSi-123HOROQKWZKA-126832

Open the `apiSix.ApiSixDashboardURL` URL and log in to configure your **APISIX** in AWS China region.


_TBD_

## Decouple APISIX and etcd3 on AWS
@@ -55,7 +55,6 @@ It is very easy for APISIX to extend the discovery client, the basic steps are a

3. Convert the registry data into data in APISIX;


### the example of Eureka

#### Implementation of eureka.lua
@@ -182,7 +181,6 @@ discovery:
read: 5000 # 5000ms
```


## Upstream setting

Here is an example of routing a request with a URL of "/user/*" to a service which named "user-service" and use eureka discovery client in the registry :
@@ -245,5 +243,3 @@ $ curl http://127.0.0.1:9080/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f
Suppose both A-SERVICE and B-SERVICE provide a `/test` API. The above configuration allows access to A-SERVICE's `/test` API through `/a/test` and B-SERVICE's `/test` API through `/b/test`.

**Notice**:When configuring `upstream.service_name`, `upstream.nodes` will no longer take effect, but will be replaced by 'nodes' obtained from the registry.


@@ -34,7 +34,6 @@ Note

- If you want use Tengine instead of OpenResty, please take a look at this installation step script [Install Tengine at Ubuntu](../.travis/linux_tengine_runner.sh).


CentOS 7
========

@@ -162,7 +162,6 @@ local _M = {
}
```


## choose phase to run

Determine which phase to run, generally access or rewrite. If you don't know the [Openresty life cycle](https://openresty-reference.readthedocs.io/en/latest/Directives/), it's
@@ -27,7 +27,6 @@
- [**Disable Plugin**](#disable-plugin)
- [**Examples**](#examples)


## Name

`authz-keycloak` is an authorization plugin to be used with the Keycloak Identity Server. Keycloak is an OAuth/OIDC and
@@ -48,8 +47,6 @@ For more information on Keycloak, refer to [Keycloak Authorization Docs](https:/
| ssl_verify | boolean | optional | true | | Verify if SSL cert matches hostname. |
| policy_enforcement_mode | string | optional | "ENFORCING" | ["ENFORCING", "PERMISSIVE"] | |



### Policy Enforcement Mode

Specifies how policies are enforced when processing authorization requests sent to the server.
@@ -62,7 +59,6 @@ Specifies how policies are enforced when processing authorization requests sent

- Requests are allowed even when there is no policy associated with a given resource.


## How To Enable

Create a `route` and enable the `authz-keycloak` plugin on the route:
@@ -87,14 +83,12 @@ curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f13
}
```
## Test Plugin
```shell
curl http://127.0.0.1:9080/get -H 'Authorization: Bearer {JWT Token}'
```
## Disable Plugin
Remove the corresponding json configuration in the plugin configuration to disable the `authz-keycloak`.
@@ -69,7 +69,6 @@ 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.

@@ -27,7 +27,6 @@
- [How to restrict service_id](#how-to-restrict-service_id)
- [Disable Plugin](#disable-plugin)


## Introduction

The `consumer-restriction` makes corresponding access restrictions based on different objects selected.
@@ -26,7 +26,6 @@
- [**Test Plugin**](#test-plugin)
- [**Disable Plugin**](#disable-plugin)


## Name

`echo` is a a useful plugin to help users understand as fully as possible how to develop an APISIX plugin.
@@ -28,7 +28,6 @@
- [**Metadata**](#metadata)
- [**Disable Plugin**](#disable-plugin)


## Name

`http-logger` is a plugin which push Log data requests to HTTP/HTTPS servers.

0 comments on commit 1f52c70

Please sign in to comment.