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/09/02 12:27:57 UTC
[GitHub] [apisix] Boburmirzo opened a new issue, #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Boburmirzo opened a new issue, #7854:
URL: https://github.com/apache/apisix/issues/7854
### Current State
Currently, we have categorization based on plugins but there is no separation by usability cases.
Actually, plugins cover many things but It is hard to navigate through an exact fit plugin for some use cases without opening the individual plugin tutorial.
For newbies will be quite challenging to understand the core use cases of API Gateway.
### Desired State
We should have a How-to-guides section with learning content per each API Gateway use case that includes the following subpages:
Expose APIs
Protect APIs
Secure API
Monitor APIs
Improve performance.
Health Check.
Add multiple versions.
Cache API responses.
Mock API responses.
Canary release.
.... more
We have already enough blog posts that cover many API Gateway use cases we can rewrite them for each how-to guide page.
Here is the link to issue #6461
https://github.com/apache/apisix/issues/6461
You can see examples for Azure API Management or Kong API Gateway how the content is structured:
--
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.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1247147443
@juzhiyuan @hf400159 I created the first PR for this issue with new How-to guide section.
https://github.com/apache/apisix/pull/7921
--
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1245016100
@hf400159 Great!
I have also many of them and bring them to the 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] juzhiyuan commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1246507598
Hi @Boburmirzo, I just checked this issue, you can create a PR and adding the new section here: https://github.com/apache/apisix/blob/master/docs/en/latest/config.json#L16-L31
--
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1246571589
> Hi @Boburmirzo, I just checked this issue, you can create a PR and adding the new section here: https://github.com/apache/apisix/blob/master/docs/en/latest/config.json#L16-L31
Okay, great. Let me have a look.
--
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 closed issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
juzhiyuan closed issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
URL: https://github.com/apache/apisix/issues/7854
--
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1242769273
@hf400159 I think we can create a new branch to work with.
You can add **How-to guides** section and I can add first two content so it will be not empty when we first time publish it:
<img width="268" alt="image" src="https://user-images.githubusercontent.com/14247607/189494240-b92cecc8-54d2-47d1-b59d-f5a48bb05b00.png">
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1246576145
@juzhiyuan It is only terminology but what I am thinking to add is just below **Getting Started** section as a separate category.
--
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1245259469
@hf400159 It is not ready yet.
If you help me with adding just a How-to-guide section just below Getting Started section with the first PR,
then I can start to convert some posts to How-to-guides.
--
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] hf400159 commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
hf400159 commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1245000902
Good, I am writing the first two content. @Boburmirzo
--
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] hf400159 commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
hf400159 commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1237613340
hi, @Boburmirzo I am doing this.
--
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] Boburmirzo commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
Boburmirzo commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1237717477
@hf400159 Great! Thank you for your help.
I will also help you with preparing some content there.
--
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] hf400159 commented on issue #7854: docs: Add How-to-guides section to APISIX Website API Gateway
Posted by GitBox <gi...@apache.org>.
hf400159 commented on issue #7854:
URL: https://github.com/apache/apisix/issues/7854#issuecomment-1245197092
hi, @Boburmirzo If you are ready, you can update 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