Skip to content

doc(Apache APISIX): add a description about Apache APISIX. #1234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 31, 2022
Merged

doc(Apache APISIX): add a description about Apache APISIX. #1234

merged 5 commits into from
May 31, 2022

Conversation

Chever-John
Copy link
Contributor

@Chever-John Chever-John commented May 11, 2022

Closes #

Description

I'm from the Apache APISIX community and would like to add a paragraph to the official GraphQL website. As a cloud-native API gateway, Apache APISIX has been designed from the beginning with the ability to identify matches for GraphQL syntax. By effectively matching GraphQL statements carried in requests, it can filter out abnormal traffic to further ensure security and improve system performance.

We want to add a paragraph. Thanks ~

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 11, 2022

CLA Signed

The committers listed above are authorized under a signed CLA.

@@ -0,0 +1,6 @@
---
name: Apache APISIX
description: Apache APISIX is a dynamic, real-time, high-performance API gateway. APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, etc. As a cloud-native API gateway, Apache APISIX already can recognize GraphQL syntax at the beginning of its design. Efficiently matching GraphQL statements carried in requests can filter out abnormal traffic to further ensure security and improve system performance. For more information, go to https://apisix.apache.org/blog/2022/03/02/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Apache APISIX is a dynamic, real-time, high-performance API gateway. APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, etc. As a cloud-native API gateway, Apache APISIX already can recognize GraphQL syntax at the beginning of its design. Efficiently matching GraphQL statements carried in requests can filter out abnormal traffic to further ensure security and improve system performance. For more information, go to https://apisix.apache.org/blog/2022/03/02/
description: Apache APISIX is a dynamic, real-time, high-performance API gateway. APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, etc. As a cloud-native API gateway, Apache APISIX already can recognize GraphQL syntax at the beginning of its design. Efficiently matching GraphQL statements carried in requests can filter out abnormal traffic to further ensure security and improve system performance. For more information, please visit [How to Use GraphQL with API Gateway Apache APISIX](https://apisix.apache.org/blog/2022/03/02/apisix-integration-graphql-plugin/)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solved

@@ -0,0 +1,6 @@
---
name: Apache APISIX
description: Apache APISIX is a dynamic, real-time, high-performance API gateway. APISIX provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, etc. As a cloud-native API gateway, Apache APISIX already can recognize GraphQL syntax at the beginning of its design. Efficiently matching GraphQL statements carried in requests can filter out abnormal traffic to further ensure security and improve system performance. For more information, go to https://apisix.apache.org/blog/2022/03/02/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ideal description length is 70-155 characters. This is just for discoverability and SEO. So, we can make it much smaller.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure~
Let me try

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Structurally this all looks good - just let me know when you're happy

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@orta I think I'm ready to go. Please review, sir.
Thanks first.

1. modify the link;
2. reduced the text to 75 words.
@Chever-John Chever-John requested a review from orta May 31, 2022 09:54
@orta
Copy link
Member

orta commented May 31, 2022

Cool, thanks folks

@orta orta merged commit 984bb4d into graphql:source May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants