Skip to content

Commit 1b96444

Browse files
authored
docs: enabling MD045 - images with alternate text (#5280)
1 parent b5d72cb commit 1b96444

23 files changed

+72
-66
lines changed

.markdownlint.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,5 +31,4 @@ MD034: false
3131
MD036: false
3232
MD040: false
3333
MD041: false
34-
MD045: false
3534
MD046: false

docs/en/latest/aws.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ title: Running APISIX in AWS with AWS CDK
2727

2828
This reference architecture walks you through building **APISIX** as a serverless container API Gateway on top of AWS Fargate with AWS CDK.
2929

30-
![](../../assets/images/aws-fargate-cdk.png)
30+
![Apache APISIX Serverless Architecture](../../assets/images/aws-fargate-cdk.png)
3131

3232
## Generate an AWS CDK project with `projen`
3333

@@ -208,15 +208,15 @@ Address: 44.226.102.63
208208

209209
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.
210210

211-
![](../../assets/images/aws-nlb-ip-addr.png)
212-
![](../../assets/images/aws-define-service.png)
213-
![](../../assets/images/aws-define-route.png)
211+
![upstream with AWS NLB IP addresses](../../assets/images/aws-nlb-ip-addr.png)
212+
![service with created upstream](../../assets/images/aws-define-service.png)
213+
![define route with service and uri](../../assets/images/aws-define-route.png)
214214

215215
## Validation
216216

217217
OK. Let's test the `/index.php` on `{apiSix.ApiSixServiceServiceURL}/index.php`
218218

219-
![](../../assets/images/aws-caddy-php-welcome-page.png)
219+
![Testing Apache APISIX on AWS Fargate](../../assets/images/aws-caddy-php-welcome-page.png)
220220

221221
Now we have been successfully running **APISIX** in AWS Fargate as serverless container API Gateway service.
222222

docs/en/latest/discovery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ title: Integration service discovery registry
2525

2626
When system traffic changes, the number of servers of the upstream service also increases or decreases, or the server needs to be replaced due to its hardware failure. If the gateway maintains upstream service information through configuration, the maintenance costs in the microservices architecture pattern are unpredictable. Furthermore, due to the untimely update of these information, will also bring a certain impact for the business, and the impact of human error operation can not be ignored. So it is very necessary for the gateway to automatically get the latest list of service instances through the service registry。As shown in the figure below:
2727

28-
![](../../assets/images/discovery.png)
28+
![discovery through service registry](../../assets/images/discovery.png)
2929

3030
1. When the service starts, it will report some of its information, such as the service name, IP, port and other information to the registry. The services communicate with the registry using a mechanism such as a heartbeat, and if the registry and the service are unable to communicate for a long time, the instance will be cancel.When the service goes offline, the registry will delete the instance information.
3131
2. The gateway gets service instance information from the registry in near-real time.

docs/en/latest/discovery/consul_kv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ title: consul_kv
2626
For users who used [nginx-upsync-module](https://github.com/weibocom/nginx-upsync-module) and consul key value for service discovery way, as we Weibo Mobile Team, maybe need it.
2727

2828
Thanks to @fatman-x guy, who developed this module, called `consul_kv`, and its worker process data flow is below:
29-
![](https://user-images.githubusercontent.com/548385/107141841-6ced3e00-6966-11eb-8aa4-bc790a4ad113.png)
29+
![consul kv module data flow diagram](https://user-images.githubusercontent.com/548385/107141841-6ced3e00-6966-11eb-8aa4-bc790a4ad113.png)
3030

3131
## Configuration for discovery client
3232

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,10 @@ title: hmac-auth
2929
- [How To Enable](#how-to-enable)
3030
- [Test Plugin](#test-plugin)
3131
- [generate signature:](#generate-signature)
32+
- [Request body checking](#request-body-checking)
3233
- [Use the generated signature to try the request](#use-the-generated-signature-to-try-the-request)
3334
- [Custom header key](#custom-header-key)
35+
- [Enable request body checking](#enable-request-body-checking)
3436
- [Disable Plugin](#disable-plugin)
3537
- [Generate Signature Examples](#generate-signature-examples)
3638

@@ -76,10 +78,10 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
7678
The default `keep_headers` is false and `encode_uri_params` is true.
7779

7880
You can visit the dashboard to complete the above operations through the web interface, first add a consumer:
79-
![](../../../assets/images/plugin/hmac-auth-1.png)
81+
![create a consumer](../../../assets/images/plugin/hmac-auth-1.png)
8082

8183
Then add the hmac-auth plugin to the consumer page:
82-
![](../../../assets/images/plugin/hmac-auth-2.png)
84+
![enable hmac plugin](../../../assets/images/plugin/hmac-auth-2.png)
8385

8486
2. add a Route or add a Service, and enable the `hmac-auth` plugin
8587

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,11 @@ title: jwt-auth
2525

2626
- [**Name**](#name)
2727
- [**Attributes**](#attributes)
28+
- [**API**](#api)
2829
- [**How To Enable**](#how-to-enable)
2930
- [**Test Plugin**](#test-plugin)
31+
- [get the token in `jwt-auth` plugin:](#get-the-token-in-jwt-auth-plugin)
32+
- [try request with token](#try-request-with-token)
3033
- [**Disable Plugin**](#disable-plugin)
3134

3235
## Name
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
111114

112115
1. Add a Consumer through the web console:
113116

114-
![](../../../assets/images/plugin/jwt-auth-1.png)
117+
![create a consumer](../../../assets/images/plugin/jwt-auth-1.png)
115118

116119
then add jwt-auth plugin in the Consumer page:
117-
![](../../../assets/images/plugin/jwt-auth-2.png)
120+
![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
118121

119122
2. Create a Route or Service object and enable the jwt-auth plugin:
120123

121-
![](../../../assets/images/plugin/jwt-auth-3.png)
124+
![enable jwt from route or service](../../../assets/images/plugin/jwt-auth-3.png)
122125

123126
## Test Plugin
124127

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
6969
```
7070

7171
You also can complete the above operation through the web interface, first add a route:
72-
![](../../../assets/images/plugin/key-auth-1.png)
72+
![create a consumer](../../../assets/images/plugin/key-auth-1.png)
7373

7474
Then add key-auth plugin:
75-
![](../../../assets/images/plugin/key-auth-2.png)
75+
![enable key-auth plugin](../../../assets/images/plugin/key-auth-2.png)
7676

7777
2. creates a route or service object, and enable plugin `key-auth`.
7878

docs/en/latest/plugins/limit-conn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
7878
```
7979

8080
You also can complete the above operation through the web interface, first add a route, then add limit-conn plugin:
81-
![](../../../assets/images/plugin/limit-conn-1.png)
81+
![enable limit-conn plugin](../../../assets/images/plugin/limit-conn-1.png)
8282

8383
## Test Plugin
8484

docs/en/latest/plugins/prometheus.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
8484

8585
First, add a Route:
8686

87-
![](../../../assets/images/plugin/prometheus-1.png)
87+
![create a route](../../../assets/images/plugin/prometheus-1.png)
8888

8989
Then add prometheus plugin:
9090

91-
![](../../../assets/images/plugin/prometheus-2.png)
91+
![enable prometheus plugin](../../../assets/images/plugin/prometheus-2.png)
9292

9393
## How to fetch the metric data
9494

@@ -114,9 +114,9 @@ scrape_configs:
114114
115115
And we can check the status at prometheus console:
116116
117-
![](../../../assets/images/plugin/prometheus01.png)
117+
![checking status on prometheus dashboard](../../../assets/images/plugin/prometheus01.png)
118118
119-
![](../../../assets/images/plugin/prometheus02.png)
119+
![prometheus apisix in-depth metric view](../../../assets/images/plugin/prometheus02.png)
120120
121121
## How to specify export uri
122122
@@ -142,13 +142,13 @@ Downloads [Grafana dashboard meta](https://github.com/apache/apisix/blob/master/
142142

143143
Or you can goto [Grafana official](https://grafana.com/grafana/dashboards/11719) for `Grafana` meta data.
144144

145-
![](../../../assets/images/plugin/grafana-1.png)
145+
![Grafana chart-1](../../../assets/images/plugin/grafana-1.png)
146146

147-
![](../../../assets/images/plugin/grafana-2.png)
147+
![Grafana chart-2](../../../assets/images/plugin/grafana-2.png)
148148

149-
![](../../../assets/images/plugin/grafana-3.png)
149+
![Grafana chart-3](../../../assets/images/plugin/grafana-3.png)
150150

151-
![](../../../assets/images/plugin/grafana-4.png)
151+
![Grafana chart-4](../../../assets/images/plugin/grafana-4.png)
152152

153153
### Available metrics
154154

docs/en/latest/plugins/response-rewrite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,6 @@ The `response-rewrite` plugin has been disabled now. It works for other plugins.
131131

132132
`ngx.exit` will interrupt the execution of the current request and return status code to Nginx.
133133

134-
![](https://cdn.jsdelivr.net/gh/Miss-you/img/picgo/20201113010623.png)
134+
![ngx.edit tabular overview](https://cdn.jsdelivr.net/gh/Miss-you/img/picgo/20201113010623.png)
135135

136136
However, if you execute `ngx.exit` during the access phase, it only interrupts the request processing phase, and the response phase will still process it, i.e. if you configure the `response-rewrite` plugin, it will force overwriting of your response information (e.g. response status code).

0 commit comments

Comments
 (0)