You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2021/10/19 04:28:05 UTC

[GitHub] [apisix] bisakhmondal opened a new pull request #5280: docs: enabling MD045 - images with alternate text

bisakhmondal opened a new pull request #5280:
URL: https://github.com/apache/apisix/pull/5280


   ### What this PR does / why we need it:
   <!--- Why is this change required? What problem does it solve? -->
   <!--- If it fixes an open issue, please link to the issue here. -->
   - Fix the existing instances of images without any alternate text.
   - Enabled MD045 in .markdownlint.yml
   
   closes #3586
   ### Pre-submission checklist:
   
   * [x] Did you explain what problem does this PR solve? Or what new features have been added?
   * [ ] Have you added corresponding test cases?
   * [x] Have you modified the corresponding document?
   * [x] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] bisakhmondal commented on a change in pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #5280:
URL: https://github.com/apache/apisix/pull/5280#discussion_r732350746



##########
File path: docs/en/latest/plugins/jwt-auth.md
##########
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
 
 1. Add a Consumer through the web console:
 
-![](../../../assets/images/plugin/jwt-auth-1.png)
+![create consumer](../../../assets/images/plugin/jwt-auth-1.png)
 
 then add jwt-auth plugin in the Consumer page:
-![](../../../assets/images/plugin/jwt-auth-2.png)
+![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
 
 2. Create a Route or Service object and enable the jwt-auth plugin:
 
-![](../../../assets/images/plugin/jwt-auth-3.png)
+![enabling jwt from route or service](../../../assets/images/plugin/jwt-auth-3.png)

Review comment:
       Hi! As these were just alternate texts and only going to be rendered if the URL is broken, I guess I didn't put much notice on the consistency of the texts that I was writing😅.  Let me update it then. Thanks.
   




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] bisakhmondal commented on a change in pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #5280:
URL: https://github.com/apache/apisix/pull/5280#discussion_r731724528



##########
File path: docs/en/latest/plugins/jwt-auth.md
##########
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
 
 1. Add a Consumer through the web console:
 
-![](../../../assets/images/plugin/jwt-auth-1.png)
+![create consumer](../../../assets/images/plugin/jwt-auth-1.png)
 
 then add jwt-auth plugin in the Consumer page:
-![](../../../assets/images/plugin/jwt-auth-2.png)
+![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
 
-2. Create a Route or Service object and enable the jwt-auth plugin:
+1. Create a Route or Service object and enable the jwt-auth plugin:

Review comment:
       ACK. Seems my vscode md lint auto-updated it.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] juzhiyuan commented on a change in pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on a change in pull request #5280:
URL: https://github.com/apache/apisix/pull/5280#discussion_r732285406



##########
File path: docs/en/latest/plugins/jwt-auth.md
##########
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
 
 1. Add a Consumer through the web console:
 
-![](../../../assets/images/plugin/jwt-auth-1.png)
+![create consumer](../../../assets/images/plugin/jwt-auth-1.png)
 
 then add jwt-auth plugin in the Consumer page:
-![](../../../assets/images/plugin/jwt-auth-2.png)
+![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
 
 2. Create a Route or Service object and enable the jwt-auth plugin:
 
-![](../../../assets/images/plugin/jwt-auth-3.png)
+![enabling jwt from route or service](../../../assets/images/plugin/jwt-auth-3.png)

Review comment:
       May I know why we use `enabling` here, but use `enable` on Line 120?

##########
File path: docs/zh/latest/plugins/key-auth.md
##########
@@ -67,10 +67,10 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
 ```
 
 你也可以通过 web 界面来完成上面的操作,先增加一个 consumer:
-![](../../../assets/images/plugin/key-auth-1.png)
+![create consumer](../../../assets/images/plugin/key-auth-1.png)

Review comment:
       ```suggestion
   ![create a consumer](../../../assets/images/plugin/key-auth-1.png)
   ```

##########
File path: docs/en/latest/aws.md
##########
@@ -208,15 +208,15 @@ 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.
 
-![](../../assets/images/aws-nlb-ip-addr.png)
-![](../../assets/images/aws-define-service.png)
-![](../../assets/images/aws-define-route.png)
+![Upstream with AWS NLB IP Addresses](../../assets/images/aws-nlb-ip-addr.png)
+![Service with Created Upstream](../../assets/images/aws-define-service.png)
+![Define Route with Service and URI](../../assets/images/aws-define-route.png)
 
 ## Validation
 
 OK. Let's test the `/index.php` on `{apiSix.ApiSixServiceServiceURL}/index.php`
 
-![](../../assets/images/aws-caddy-php-welcome-page.png)
+![Testing APISIX on AWS Fargate](../../assets/images/aws-caddy-php-welcome-page.png)

Review comment:
       ```suggestion
   ![Testing Apache APISIX on AWS Fargate](../../assets/images/aws-caddy-php-welcome-page.png)
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] bisakhmondal commented on a change in pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on a change in pull request #5280:
URL: https://github.com/apache/apisix/pull/5280#discussion_r732369754



##########
File path: docs/en/latest/plugins/jwt-auth.md
##########
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
 
 1. Add a Consumer through the web console:
 
-![](../../../assets/images/plugin/jwt-auth-1.png)
+![create consumer](../../../assets/images/plugin/jwt-auth-1.png)
 
 then add jwt-auth plugin in the Consumer page:
-![](../../../assets/images/plugin/jwt-auth-2.png)
+![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
 
 2. Create a Route or Service object and enable the jwt-auth plugin:
 
-![](../../../assets/images/plugin/jwt-auth-3.png)
+![enabling jwt from route or service](../../../assets/images/plugin/jwt-auth-3.png)

Review comment:
       fixed.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] spacewander merged pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #5280:
URL: https://github.com/apache/apisix/pull/5280


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [apisix] spacewander commented on a change in pull request #5280: docs: enabling MD045 - images with alternate text

Posted by GitBox <gi...@apache.org>.
spacewander commented on a change in pull request #5280:
URL: https://github.com/apache/apisix/pull/5280#discussion_r731500179



##########
File path: docs/en/latest/plugins/jwt-auth.md
##########
@@ -111,14 +114,14 @@ You can use [APISIX Dashboard](https://github.com/apache/apisix-dashboard) to co
 
 1. Add a Consumer through the web console:
 
-![](../../../assets/images/plugin/jwt-auth-1.png)
+![create consumer](../../../assets/images/plugin/jwt-auth-1.png)
 
 then add jwt-auth plugin in the Consumer page:
-![](../../../assets/images/plugin/jwt-auth-2.png)
+![enable jwt plugin](../../../assets/images/plugin/jwt-auth-2.png)
 
-2. Create a Route or Service object and enable the jwt-auth plugin:
+1. Create a Route or Service object and enable the jwt-auth plugin:

Review comment:
       Should be step 2?

##########
File path: docs/zh/latest/plugins/prometheus.md
##########
@@ -113,9 +113,9 @@ scrape_configs:
 
 我们也可以在 prometheus 控制台中去检查状态:
 
-![](../../../assets/images/plugin/prometheus01.png)
+![checking status on prometheus dashboard](../../../assets/images/plugin/prometheus01.png)
 
-![](../../../assets/images/plugin/prometheus02.png)
+![checking status on prometheus dashboard](../../../assets/images/plugin/prometheus02.png)

Review comment:
       Ditto

##########
File path: docs/en/latest/plugins/zipkin.md
##########
@@ -121,9 +122,9 @@ Then you can use a browser to access the webUI of Zipkin:
 http://127.0.0.1:9411/zipkin
 ```
 
-![](../../../assets/images/plugin/zipkin-1.jpg)
+![zipkin web-ui](../../../assets/images/plugin/zipkin-1.jpg)
 
-![](../../../assets/images/plugin/zipkin-2.jpg)
+![zipkin web-ui](../../../assets/images/plugin/zipkin-2.jpg)

Review comment:
       Ditto

##########
File path: docs/en/latest/plugins/prometheus.md
##########
@@ -114,9 +114,9 @@ scrape_configs:
 
 And we can check the status at prometheus console:
 
-![](../../../assets/images/plugin/prometheus01.png)
+![checking status on prometheus dashboard](../../../assets/images/plugin/prometheus01.png)
 
-![](../../../assets/images/plugin/prometheus02.png)
+![checking status on prometheus dashboard](../../../assets/images/plugin/prometheus02.png)

Review comment:
       Better to use a different name for different image

##########
File path: docs/zh/latest/plugins/zipkin.md
##########
@@ -121,9 +121,9 @@ HTTP/1.1 200 OK
 http://127.0.0.1:9411/zipkin
 ```
 
-![](../../../assets/images/plugin/zipkin-1.jpg)
+![zipkin web-ui](../../../assets/images/plugin/zipkin-1.jpg)
 
-![](../../../assets/images/plugin/zipkin-2.jpg)
+![zipkin web-ui](../../../assets/images/plugin/zipkin-2.jpg)

Review comment:
       Ditto




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org