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: Corrected typos and grammatical errors #9216

Merged
merged 1 commit into from
Apr 7, 2023
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
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion CODE_STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion THREAT_MODEL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/en/latest/discovery/consul.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/en/latest/discovery/control-plane-service-discovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
---

<!--
Expand Down Expand Up @@ -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).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/discovery/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/en/latest/discovery/nacos.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 '
Expand Down Expand Up @@ -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 '
Expand Down Expand Up @@ -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 '
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/internal/testing-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
6 changes: 3 additions & 3 deletions docs/en/latest/plugins/aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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 '
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/fault-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/forward-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
| ----------------- | ------------------ | ---------------- | --------------- | --------------- |
Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/gm.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/grpc-web.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion powered-by.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down