[GitHub] [apisix-ingress-controller] navendu-pottekkat commented on a diff in pull request #1018: doc: update "enable-authentication-and-restriction.md" doc, and examples of `jwt-auth` and `wolf-rbac`.

[GitBox <gi...@apache.org>]

navendu-pottekkat commented on code in PR #1018:
URL: https://github.com/apache/apisix-ingress-controller/pull/1018#discussion_r875475639


##########
docs/en/latest/practices/enable-authentication-and-restriction.md:
##########
@@ -27,36 +27,124 @@ Consumers are used for the authentication method controlled by Apache APISIX, if
 
 ## Attributes
 
-### Authentication
+### Authentication methods
 
-#### [`keyAuth`](https://apisix.apache.org/docs/apisix/plugins/key-auth/)
+#### `keyAuth`
 
-Consumers add their key either in a header `apikey` to authenticate their requests.
+Consumers add their key either in a header `apikey` to authenticate their requests. For more information about `keyAuth`, please refer to [APISIX jwt-auth](https://apisix.apache.org/docs/apisix/plugins/key-auth/).
+
+<details>

Review Comment:
   Do we have specific reason to use this? If so, could you add it to the style guide on when to use this?



##########
docs/en/latest/practices/enable-authentication-and-restriction.md:
##########
@@ -27,36 +27,124 @@ Consumers are used for the authentication method controlled by Apache APISIX, if
 
 ## Attributes
 
-### Authentication
+### Authentication methods
 
-#### [`keyAuth`](https://apisix.apache.org/docs/apisix/plugins/key-auth/)
+#### `keyAuth`
 
-Consumers add their key either in a header `apikey` to authenticate their requests.
+Consumers add their key either in a header `apikey` to authenticate their requests. For more information about `keyAuth`, please refer to [APISIX jwt-auth](https://apisix.apache.org/docs/apisix/plugins/key-auth/).
+
+<details>
+  <summary>keyAuth yaml configure</summary>
 
 ```yaml
-keyAuth:
-  value:
-    key: ${key}
+apiVersion: apisix.apache.org/v2beta3
+kind: ApisixConsumer
+metadata:
+  name: ${name}

Review Comment:
   @AlinsRan Does the `${name}` here refer to a value the user has to set? Or is it somehow a variable they are passing?
   
   In the past we have been using `name: user-configured-name` or some placeholder like that.
   
   // @juzhiyuan @hf400159 



-- 
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