This is a proposed structure I think the Project Docs should take. Please
include other contents that you think are missing from this page.
Also add your review. Thanks
Project Documentation:
*Overview*
Apache APISIX is a cloud-native high-performing API gateway, that delivers
the ultimate performance, security, open-source and scalable platform for
all your APIs and microservices.
It provides hundreds of items such as load balancing, dynamic upstream,
grayscale publishing, refined routing, current and speed limiting, service
degradation, service fuse, identity authentication, and observability.
- *What is Apache APISIX*
Apache APISIX is an open source, dynamic, high-performance, and scalable
7-layer proxy. It acts as a service bus that connects APIs and
microservices in cloud-native architectures.
- *The problem APISIX solves*
- Help enterprises to solve the difficulties in the transformation of
traditional monolithic architecture, so as to achieve rapid
iteration of
business and products.
- Apache APISIX handles traditional north-south traffic, as well as
east-west traffic between services. It can also be used as a k8s ingress
controller <https://github.com/apache/apisix-ingress-controller>.
- Easy to use: APISIX also consists of a built-in low-code dashboard
that offers a powerful and flexible interface. You can write your own
custom plugins or use custom load balancing algorithms.
- Apache APISIX supports multi-platforms, languages and protocols.
- *Features*
Apache APISIX not only covers the traditional functions of NGINX, but also
deeply cooperates with Apache SkyWalking in observability, which greatly
improves service governance capabilities. Some of the characteristics of
the Apache APISIX gateway include;
- Full Dynamic
- Fine-grained routing
- OPS friendly
- Highly scalable
- Security
- Multi protocols
- Multi-Language support
*Getting started *
-
*Architecture*
- requires a detailed description of the architecture diagram.
- Core Concepts
*Platforms*
This will list the different ways to run and install APISIX on different
platforms.
- Kubernetes
- Helm
- Mac
*How to Build*
-
*Plugins <https://apisix.apache.org/docs/apisix/how-to-build#>*
-
*API <https://apisix.apache.org/docs/apisix/how-to-build#>*
*Release Management*
This release guide already exists under resources, but I think it should be
under documentation.
*CHANGELOG <https://github.com/apache/apisix/blob/master/CHANGELOG.md>*
-
*Others <https://apisix.apache.org/docs/apisix/how-to-build#>*
-
*Reference*
-
- *Highlight the existing sites that reference APISIX*
*FAQ <https://apisix.apache.org/docs/apisix/FAQ>*
-
