Skip to content

Commit 8805fc5

Browse files
authored
docs: Corrected typos and grammatical errors (apache#9216)
1 parent 59b6e76 commit 8805fc5

14 files changed

+19
-19
lines changed

CODE_OF_CONDUCT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ We strive to:
6565
* Repeated harassment of others. In general, if someone asks you to stop, then stop.
6666
* Advocating for, or encouraging, any of the above behaviour.
6767

68-
6. __Be concise.__ Keep in mind that what you write once will be read by hundreds of persons. Writing a short email means people can understand the conversation as efficiently as possible. Short emails should always strive to be empathetic, welcoming, friendly and patient. When a long explanation is necessary, consider adding a summary.</p>
68+
6. __Be concise.__ Keep in mind that what you write once will be read by hundreds of people. Writing a short email means people can understand the conversation as efficiently as possible. Short emails should always strive to be empathetic, welcoming, friendly and patient. When a long explanation is necessary, consider adding a summary.</p>
6969

7070
Try to bring new ideas to a conversation so that each mail adds something unique to the thread, keeping in mind that the rest of the thread still contains the other messages with arguments that have already been made.
7171

CODE_STYLE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ end
322322

323323
The function should return `<boolean>`, `err`.
324324
The first return value means successful or not, if not, the second return value specifies the error message.
325-
The error message can be ignored in some case.
325+
The error message can be ignored in some cases.
326326

327327
```lua
328328
--No

THREAT_MODEL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ We should keep security in mind, and validate the input from the client before u
5757

5858
As the maintainer:
5959
We should keep security in mind, and review the code line by line.
60-
We are open to the discussion from the security researchers.
60+
We are open to discussion from the security researchers.

docs/en/latest/discovery/consul.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ curl -X PUT 'http://127.0.0.1:8500/v1/agent/service/register' \
143143
}'
144144
```
145145

146-
In some case, same service name exist in different consul servers.
146+
In some cases, same service name might exist in different consul servers.
147147
To avoid confusion, use the full consul key url path as service name in practice.
148148

149149
### Upstream setting

docs/en/latest/discovery/control-plane-service-discovery.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ keywords:
66
- ZooKeeper
77
- Nacos
88
- APISIX-Seed
9-
description: This documentation describes implement service discovery through Nacos and ZooKeeper on the API Gateway APISIX Control Plane.
9+
description: This documentation describes implementing service discovery through Nacos and ZooKeeper on the API Gateway APISIX Control Plane.
1010
---
1111

1212
<!--
@@ -45,7 +45,7 @@ The specific information represented by the figures in the figure is as follows:
4545

4646
:::note
4747

48-
It should be noted that after the introduction of APISIX-Seed, if the service of the registry changes frequently, the data in etcd will also change frequently. So, it is best to set the `--auto-compaction` option when starting etcd to compress the history periodically to avoid etcd eventually exhaust its storage space. Please refer to [revisions](https://etcd.io/docs/v3.5/learning/api/#revisions).
48+
It should be noted that after the introduction of APISIX-Seed, if the service of the registry changes frequently, the data in etcd will also change frequently. So, it is best to set the `--auto-compaction` option when starting etcd to compress the history periodically to avoid etcd eventually exhausting its storage space. Please refer to [revisions](https://etcd.io/docs/v3.5/learning/api/#revisions).
4949

5050
:::
5151

docs/en/latest/discovery/kubernetes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ use kubernetes discovery in L4 require OpenResty version >= 1.19.9.1
4242

4343
## How To Use
4444

45-
Kubernetes service discovery both support single-cluster and multi-cluster mode, applicable to the case where the service is distributed in a single or multiple Kubernetes clusters.
45+
Kubernetes service discovery both support single-cluster and multi-cluster modes, applicable to the case where the service is distributed in single or multiple Kubernetes clusters.
4646

4747
### Single-Cluster Mode Configuration
4848

docs/en/latest/discovery/nacos.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ $ curl http://127.0.0.1:9180/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f
124124

125125
#### Specify the namespace
126126

127-
Example of routing a request with an URI of "/nacosWithNamespaceId/*" to a service which name, namespaceId "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns" and use nacos discovery client in the registry:
127+
Example of routing a request with an URI of "/nacosWithNamespaceId/*" to a service with name, namespaceId "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns" and use nacos discovery client in the registry:
128128

129129
```shell
130130
$ curl http://127.0.0.1:9180/apisix/admin/routes/2 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
@@ -172,7 +172,7 @@ The formatted response as below:
172172

173173
#### Specify the group
174174

175-
Example of routing a request with an URI of "/nacosWithGroupName/*" to a service which name, groupName "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&groupName=test_group" and use nacos discovery client in the registry:
175+
Example of routing a request with an URI of "/nacosWithGroupName/*" to a service with name, groupName "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&groupName=test_group" and use nacos discovery client in the registry:
176176

177177
```shell
178178
$ curl http://127.0.0.1:9180/apisix/admin/routes/3 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
@@ -220,7 +220,7 @@ The formatted response as below:
220220

221221
#### Specify the namespace and group
222222

223-
Example of routing a request with an URI of "/nacosWithNamespaceIdAndGroupName/*" to a service which name, namespaceId, groupName "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns&groupName=test_group" and use nacos discovery client in the registry:
223+
Example of routing a request with an URI of "/nacosWithNamespaceIdAndGroupName/*" to a service with name, namespaceId, groupName "http://192.168.33.1:8848/nacos/v1/ns/instance/list?serviceName=APISIX-NACOS&namespaceId=test_ns&groupName=test_group" and use nacos discovery client in the registry:
224224

225225
```shell
226226
$ curl http://127.0.0.1:9180/apisix/admin/routes/4 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '

docs/en/latest/internal/testing-framework.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ no valid upstream node
116116
To test the code, we need to provide a mock upstream.
117117

118118
For HTTP request, the upstream code is put in `t/lib/server.lua`. HTTP request with
119-
a given `path` will trigger the method in same name. For example, a call to `/server_port`
119+
a given `path` will trigger the method in the same name. For example, a call to `/server_port`
120120
will call the `_M.server_port`.
121121

122122
For TCP request, a dummy upstream is used:

docs/en/latest/plugins/aws-lambda.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ description: This document contains information about the Apache APISIX aws-lamb
3131

3232
The `aws-lambda` Plugin is used for integrating APISIX with [AWS Lambda](https://aws.amazon.com/lambda/) as a dynamic upstream to proxy all requests for a particular URI to the AWS Cloud.
3333

34-
When enabled, the Plugin terminates the ongoing request to the configured URI and initiates a new request to the AWS Lambda Gateway URI on behalf of the client with configured authorization details, request headers, body and parameters (all three passed from the original request). It returns back the response with headers, status code and the body to the client that initiated the request with APISIX.
34+
When enabled, the Plugin terminates the ongoing request to the configured URI and initiates a new request to the AWS Lambda Gateway URI on behalf of the client with configured authorization details, request headers, body and parameters (all three passed from the original request). It returns the response with headers, status code and the body to the client that initiated the request with APISIX.
3535

3636
This Plugin supports authorization via AWS API key and AWS IAM secrets.
3737

@@ -119,7 +119,7 @@ server: APISIX/2.10.2
119119
"Hello, APISIX!"
120120
```
121121

122-
Similarly the function can be triggered via AWS API Gateway by using AWS IAM permissions for authorization. The Plugin includes authentication signatures in HTTP calls via AWS v4 request signing. The example below shows this method:
122+
Similarly, the function can be triggered via AWS API Gateway by using AWS IAM permissions for authorization. The Plugin includes authentication signatures in HTTP calls via AWS v4 request signing. The example below shows this method:
123123

124124
```shell
125125
curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
@@ -148,7 +148,7 @@ This approach assumes that you have already an IAM user with programmatic access
148148

149149
### Configuring path forwarding
150150

151-
The `aws-lambda` Plugins also supports URL path forwarding while proxying requests to the AWS upstream. Extensions to the base request path gets appended to the `function_uri` specified in the Plugin configuration.
151+
The `aws-lambda` Plugin also supports URL path forwarding while proxying requests to the AWS upstream. Extensions to the base request path gets appended to the `function_uri` specified in the Plugin configuration.
152152

153153
:::info IMPORTANT
154154

docs/en/latest/plugins/fault-injection.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The `fault-injection` Plugin can be used to test the resiliency of your applicat
3434

3535
The `abort` attribute will directly return the specified HTTP code to the client and skips executing the subsequent Plugins.
3636

37-
The `delay` attribute delays a request and executes of the subsequent Plugins.
37+
The `delay` attribute delays a request and executes the subsequent Plugins.
3838

3939
## Attributes
4040

docs/en/latest/plugins/forward-auth.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This Plugin moves the authentication and authorization logic to a dedicated exte
5151

5252
## Data definition
5353

54-
APISIX will generate and the send the request headers listed below to the authorization service:
54+
APISIX will generate and send the request headers listed below to the authorization service:
5555

5656
| Scheme | HTTP Method | Host | URI | Source IP |
5757
| ----------------- | ------------------ | ---------------- | --------------- | --------------- |

docs/en/latest/plugins/gm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ description: This article introduces the basic information and usage of the Apac
2727
-->
2828

2929
:::info
30-
The function usage scenarios introduced in this article are mainly in China, so this article only has a Chinese version temporarily. You can cilik [here](https://apisix.apache.org/zh/docs/apisix/plugins/gm/) for more details. If you are interested in this feature, welcome to translate this document.
30+
The function usage scenarios introduced in this article are mainly in China, so this article only has a Chinese version temporarily. You can click [here](https://apisix.apache.org/zh/docs/apisix/plugins/gm/) for more details. If you are interested in this feature, welcome to translate this document.
3131
:::

docs/en/latest/plugins/grpc-web.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
5555

5656
:::info IMPORTANT
5757

58-
While using the `grpc-web` Plugin, always using a prefix matching pattern (`/*`, `/grpc/example/*`) for matching Routes. This is because the gRPC Web client passes the package name, the service interface name, the method name and other information in the proto in the URI. For example, `/path/a6.RouteService/Insert`.
58+
While using the `grpc-web` Plugin, always use a prefix matching pattern (`/*`, `/grpc/example/*`) for matching Routes. This is because the gRPC Web client passes the package name, the service interface name, the method name and other information in the proto in the URI. For example, `/path/a6.RouteService/Insert`.
5959

6060
So, when absolute matching is used, the Plugin would not be hit and the information from the proto would not be extracted.
6161

powered-by.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Users are encouraged to add themselves to this page, [issue](https://github.com/
105105

106106
## NASA JPL
107107

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

110110
## ke.com
111111

0 commit comments

Comments
 (0)