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 2022/10/21 07:12:21 UTC
[GitHub] [apisix-ingress-controller] navendu-pottekkat opened a new pull request, #1399: docs: update annotations page
navendu-pottekkat opened a new pull request, #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399
Signed-off-by: Navendu Pottekkat <na...@apache.org>
Updates "Annotations" page.
Moves the page out of the "Concepts" section as a separate reference guide.
--
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-ingress-controller] navendu-pottekkat commented on a diff in pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#discussion_r1002866483
##########
docs/en/latest/config.json:
##########
@@ -60,10 +60,13 @@
"concepts/apisix_route",
"concepts/apisix_upstream",
"concepts/apisix_tls",
- "concepts/apisix_cluster_config",
- "concepts/annotations"
+ "concepts/apisix_cluster_config"
]
},
+ {
+ "type": "doc",
+ "id": "annotations"
+ },
Review Comment:
Okay. That kinda makes sense. I will move the page back.
--
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-ingress-controller] tao12345666333 commented on a diff in pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on code in PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#discussion_r1002842015
##########
docs/en/latest/config.json:
##########
@@ -60,10 +60,13 @@
"concepts/apisix_route",
"concepts/apisix_upstream",
"concepts/apisix_tls",
- "concepts/apisix_cluster_config",
- "concepts/annotations"
+ "concepts/apisix_cluster_config"
]
},
+ {
+ "type": "doc",
+ "id": "annotations"
+ },
Review Comment:
Although annotations are a concept in Kubernetes, the configuration items that users can use are specific to APISIX Ingress.
Users need learn these "concepts" when using this project,
and we don't need to introduce the Ingress resource, because it is an existing concept in Kubernetes, and there is nothing special in the APISIX Ingress project,
what do you think?
--
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-ingress-controller] navendu-pottekkat commented on pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#issuecomment-1288629982
@tao12345666333 Now that I think about it, one of the reasons I thought moving the annotations page to a separate root-level page was discoverability for the user. An APISIX Ingress user might want to look up the annotations available and it might not be intuitive to check under the concepts section.
--
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-ingress-controller] tao12345666333 commented on a diff in pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on code in PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#discussion_r1002654338
##########
docs/en/latest/config.json:
##########
@@ -60,10 +60,13 @@
"concepts/apisix_route",
"concepts/apisix_upstream",
"concepts/apisix_tls",
- "concepts/apisix_cluster_config",
- "concepts/annotations"
+ "concepts/apisix_cluster_config"
]
},
+ {
+ "type": "doc",
+ "id": "annotations"
+ },
Review Comment:
thanks for your contribution
But I think annotations are more appropriate in concepts.
Is there any reason for you to separate it into a separate page?
--
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-ingress-controller] juzhiyuan merged pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399
--
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-ingress-controller] navendu-pottekkat commented on pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#issuecomment-1288411272
@tao12345666333 I have moved back the page to under concepts.
--
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-ingress-controller] navendu-pottekkat commented on a diff in pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#discussion_r1002662646
##########
docs/en/latest/config.json:
##########
@@ -60,10 +60,13 @@
"concepts/apisix_route",
"concepts/apisix_upstream",
"concepts/apisix_tls",
- "concepts/apisix_cluster_config",
- "concepts/annotations"
+ "concepts/apisix_cluster_config"
]
},
+ {
+ "type": "doc",
+ "id": "annotations"
+ },
Review Comment:
Annotations are used in Kubernetes native Ingress resource while rest of the concepts is specific to APISIX's CRDs. IMO, annotations are a different entity. And it does not belong together with the concepts. I'm just thinking this out loud. Would like to hear your thoughts on this as well.
--
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-ingress-controller] tao12345666333 commented on a diff in pull request #1399: docs: update annotations page
Posted by GitBox <gi...@apache.org>.
tao12345666333 commented on code in PR #1399:
URL: https://github.com/apache/apisix-ingress-controller/pull/1399#discussion_r1002879156
##########
docs/en/latest/config.json:
##########
@@ -60,10 +60,13 @@
"concepts/apisix_route",
"concepts/apisix_upstream",
"concepts/apisix_tls",
- "concepts/apisix_cluster_config",
- "concepts/annotations"
+ "concepts/apisix_cluster_config"
]
},
+ {
+ "type": "doc",
+ "id": "annotations"
+ },
Review Comment:
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