navendu-pottekkat commented on issue #1673: URL: https://github.com/apache/apisix-ingress-controller/issues/1673#issuecomment-1445268295
@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. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
