Discuss: redesign documentation

[tao12345666333]

I have received feedback from some users that the documentation for the current project is not perfect. including its structure.

I have thought about a new structure, please discuss it together.

[basuotian]

As a user, i would like to have complete information about how to config apisix plugins in apisixroute, such like proxy-rewrite, but currently there is only a few example in How-To tutorials

[tao12345666333]

thanks for your feedback.

In the new structure, I want to put them under Features and Benefits -> Explanation of each feature - Plugins

[tao12345666333]

thanks for your feedback.

In the new structure, I want to put them under Features and Benefits -> Explanation of each feature - Plugins

[Fabriceli]

As a developer, I want to know how to run e2e test, and wan to know how to fix the error when run the e2e test.
As a User, I want to know configuration the more plugins, e.g. limit-req, limit-conn, traffic-split...

[tao12345666333]

Thanks, the contents about how to run the e2e test and some techniques will put them under Technical Reference - Explanation of how the project works - Develop Guide and How to run e2e test cases.

[pottekkat]

@tao12345666333 Couple of comments while I was thinking this through.

1. We can probably merge the "overview," and the "getting started" page mentioned in this proposal to a single "getting started" page or the landing page of the Ingress controller docs. This would be similar to the APISIX docs. The only thing missing from our current getting started page is a basic walkthrough which we have to think about better on how to structure it.
2. Ingress controller might soon become an outdated term, so should we think about gateway? This page should at least mention the Gateway API and the CRDs as well. I don't think we should mention other ingress controller projects in our documentation.
3. Will the technical reference section contain the API reference?
4. How would we differentiate the "features and benefit" section from the one proposed on the "getting started" page?
5. The "limitations" section could be inline. i.e, when we are mentioning something related, we can also mention the limitations and caveats associated with it in a highlighted note. This would make it easy for the user.
6. The roadmap could be an md file on GitHub and can be an external link on the website, similar to how we have linked the changelog.
7. The design and technical details could be merged into a single section and not mixed with the developer section.
8. We might need to keep the installation section instead of everything being turned into a tutorial. Because once installed on any platform, the rest of the operation would more or less remain the same.

Let us try to iterate on this and get more direct feedback from ingress users before implementing and overhaul.