You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by na...@apache.org on 2023/04/07 05:06:31 UTC
[apisix] branch master updated: docs: Corrected typos and grammatical errors (#9216)
This is an automated email from the ASF dual-hosted git repository.
navendu 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 8805fc543 docs: Corrected typos and grammatical errors (#9216)
8805fc543 is described below
commit 8805fc543f03bf04eec656d69eb46ed2377db1ce
Author: Pratyay Banerjee <pu...@gmail.com>
AuthorDate: Fri Apr 7 10:36:25 2023 +0530
docs: Corrected typos and grammatical errors (#9216)
---
CODE_OF_CONDUCT.md | 2 +-
CODE_STYLE.md | 2 +-
THREAT_MODEL.md | 2 +-
docs/en/latest/discovery/consul.md | 2 +-
docs/en/latest/discovery/control-plane-service-discovery.md | 4 ++--
docs/en/latest/discovery/kubernetes.md | 2 +-
docs/en/latest/discovery/nacos.md | 6 +++---
docs/en/latest/internal/testing-framework.md | 2 +-
docs/en/latest/plugins/aws-lambda.md | 6 +++---
docs/en/latest/plugins/fault-injection.md | 2 +-
docs/en/latest/plugins/forward-auth.md | 2 +-
docs/en/latest/plugins/gm.md | 2 +-
docs/en/latest/plugins/grpc-web.md | 2 +-
powered-by.md | 2 +-
14 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index 7a96ea5db..fe93188bc 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -65,7 +65,7 @@ We strive to:
* Repeated harassment of others. In general, if someone asks you to stop, then stop.
* Advocating for, or encouraging, any of the above behaviour.
-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>
+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>
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.
diff --git a/CODE_STYLE.md b/CODE_STYLE.md
index 9b25f552c..f19bf355a 100644
--- a/CODE_STYLE.md
+++ b/CODE_STYLE.md
@@ -322,7 +322,7 @@ end
The function should return `<boolean>`, `err`.
The first return value means successful or not, if not, the second return value specifies the error message.
-The error message can be ignored in some case.
+The error message can be ignored in some cases.
```lua
--No
diff --git a/THREAT_MODEL.md b/THREAT_MODEL.md
index e537d1a46..c10560c4d 100644
--- a/THREAT_MODEL.md
+++ b/THREAT_MODEL.md
@@ -57,4 +57,4 @@ We should keep security in mind, and validate the input from the client before u
As the maintainer:
We should keep security in mind, and review the code line by line.
-We are open to the discussion from the security researchers.
+We are open to discussion from the security researchers.
diff --git a/docs/en/latest/discovery/consul.md b/docs/en/latest/discovery/consul.md
index e31a83690..b4eab61e9 100644
--- a/docs/en/latest/discovery/consul.md
+++ b/docs/en/latest/discovery/consul.md
@@ -143,7 +143,7 @@ curl -X PUT 'http://127.0.0.1:8500/v1/agent/service/register' \
}'
```
-In some case, same service name exist in different consul servers.
+In some cases, same service name might exist in different consul servers.
To avoid confusion, use the full consul key url path as service name in practice.
### Upstream setting
diff --git a/docs/en/latest/discovery/control-plane-service-discovery.md b/docs/en/latest/discovery/control-plane-service-discovery.md
index acd4923a9..71fc6c7c4 100644
--- a/docs/en/latest/discovery/control-plane-service-discovery.md
+++ b/docs/en/latest/discovery/control-plane-service-discovery.md
@@ -6,7 +6,7 @@ keywords:
- ZooKeeper
- Nacos
- APISIX-Seed
-description: This documentation describes implement service discovery through Nacos and ZooKeeper on the API Gateway APISIX Control Plane.
+description: This documentation describes implementing service discovery through Nacos and ZooKeeper on the API Gateway APISIX Control Plane.
---
<!--
@@ -45,7 +45,7 @@ The specific information represented by the figures in the figure is as follows:
:::note
-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).
+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).
:::
diff --git a/docs/en/latest/discovery/kubernetes.md b/docs/en/latest/discovery/kubernetes.md
index e022d0eca..e062fd9e4 100644
--- a/docs/en/latest/discovery/kubernetes.md
+++ b/docs/en/latest/discovery/kubernetes.md
@@ -42,7 +42,7 @@ use kubernetes discovery in L4 require OpenResty version >= 1.19.9.1
## How To Use
-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.
+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.
### Single-Cluster Mode Configuration
diff --git a/docs/en/latest/discovery/nacos.md b/docs/en/latest/discovery/nacos.md
index ace1860e9..35fee254b 100644
--- a/docs/en/latest/discovery/nacos.md
+++ b/docs/en/latest/discovery/nacos.md
@@ -124,7 +124,7 @@ $ curl http://127.0.0.1:9180/apisix/admin/stream_routes/1 -H 'X-API-KEY: edd1c9f
#### Specify the namespace
-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:
+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:
```shell
$ 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:
#### Specify the group
-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:
+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:
```shell
$ 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:
#### Specify the namespace and group
-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:
+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:
```shell
$ curl http://127.0.0.1:9180/apisix/admin/routes/4 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -i -d '
diff --git a/docs/en/latest/internal/testing-framework.md b/docs/en/latest/internal/testing-framework.md
index 846b2fa55..db84a23e0 100644
--- a/docs/en/latest/internal/testing-framework.md
+++ b/docs/en/latest/internal/testing-framework.md
@@ -116,7 +116,7 @@ no valid upstream node
To test the code, we need to provide a mock upstream.
For HTTP request, the upstream code is put in `t/lib/server.lua`. HTTP request with
-a given `path` will trigger the method in same name. For example, a call to `/server_port`
+a given `path` will trigger the method in the same name. For example, a call to `/server_port`
will call the `_M.server_port`.
For TCP request, a dummy upstream is used:
diff --git a/docs/en/latest/plugins/aws-lambda.md b/docs/en/latest/plugins/aws-lambda.md
index b78fcd3aa..cc24bbd93 100644
--- a/docs/en/latest/plugins/aws-lambda.md
+++ b/docs/en/latest/plugins/aws-lambda.md
@@ -31,7 +31,7 @@ description: This document contains information about the Apache APISIX aws-lamb
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.
-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.
+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.
This Plugin supports authorization via AWS API key and AWS IAM secrets.
@@ -119,7 +119,7 @@ server: APISIX/2.10.2
"Hello, APISIX!"
```
-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:
+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:
```shell
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
### Configuring path forwarding
-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.
+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.
:::info IMPORTANT
diff --git a/docs/en/latest/plugins/fault-injection.md b/docs/en/latest/plugins/fault-injection.md
index 0e8977ca8..58dc53d01 100644
--- a/docs/en/latest/plugins/fault-injection.md
+++ b/docs/en/latest/plugins/fault-injection.md
@@ -34,7 +34,7 @@ The `fault-injection` Plugin can be used to test the resiliency of your applicat
The `abort` attribute will directly return the specified HTTP code to the client and skips executing the subsequent Plugins.
-The `delay` attribute delays a request and executes of the subsequent Plugins.
+The `delay` attribute delays a request and executes the subsequent Plugins.
## Attributes
diff --git a/docs/en/latest/plugins/forward-auth.md b/docs/en/latest/plugins/forward-auth.md
index 9b9bbcfe8..0e88ab8bf 100644
--- a/docs/en/latest/plugins/forward-auth.md
+++ b/docs/en/latest/plugins/forward-auth.md
@@ -51,7 +51,7 @@ This Plugin moves the authentication and authorization logic to a dedicated exte
## Data definition
-APISIX will generate and the send the request headers listed below to the authorization service:
+APISIX will generate and send the request headers listed below to the authorization service:
| Scheme | HTTP Method | Host | URI | Source IP |
| ----------------- | ------------------ | ---------------- | --------------- | --------------- |
diff --git a/docs/en/latest/plugins/gm.md b/docs/en/latest/plugins/gm.md
index 369bb367f..99776f66e 100644
--- a/docs/en/latest/plugins/gm.md
+++ b/docs/en/latest/plugins/gm.md
@@ -27,5 +27,5 @@ description: This article introduces the basic information and usage of the Apac
-->
:::info
-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.
+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.
:::
diff --git a/docs/en/latest/plugins/grpc-web.md b/docs/en/latest/plugins/grpc-web.md
index e83961361..c8ea77c5c 100644
--- a/docs/en/latest/plugins/grpc-web.md
+++ b/docs/en/latest/plugins/grpc-web.md
@@ -55,7 +55,7 @@ curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
:::info IMPORTANT
-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`.
+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`.
So, when absolute matching is used, the Plugin would not be hit and the information from the proto would not be extracted.
diff --git a/powered-by.md b/powered-by.md
index 6b77a6e57..1b255c1d9 100644
--- a/powered-by.md
+++ b/powered-by.md
@@ -105,7 +105,7 @@ Users are encouraged to add themselves to this page, [issue](https://github.com/
## NASA JPL
-Using Apache APISIX as a API gateway to deal with north-south and east-west traffic between microservices.
+Using Apache APISIX as an API gateway to deal with north-south and east-west traffic between microservices.
## ke.com