I think enhancing documentation should be a long-term strategy for the community.
Documents should not be too much, but they need to be maintained like we maintain code. For every pull request, if some documents get out-of-date, they should be updated in the same pull request. Maybe we should remove unnecessary documents first before we enforce this rule since nobody wants to spend efforts on a broken window. The Good Docs Project is working on creating good document templates, maybe we can also choose some templates from the project: https://thegooddocsproject.dev/ On Mon, Nov 16, 2020 at 11:29 PM YuanSheng Wang <[email protected]> wrote: > We really need it, we implemented a lot of important features, but the > developers can not know them easily. > > So I think we need this job very much. I will leave messages when I have > any idea about this thing. > > > > On Mon, Nov 16, 2020 at 5:23 PM Ming Wen <[email protected]> wrote: > > > hello, community > > Apache APISIX now has a lot of features, but the documentation can't keep > > up. > > > > I am willing to lead the delivery of documents to make Apache APISIX, > > dashboard, website, etc. more convenient and easy to use. > > > > I intend to start from the following aspects: > > 1. Refactor the README page of the Apache APISIX project to hide some > > technical details and use more diagrams instead of text. > > 2. Introduce the advanced functions of Apache APISIX in more detail, such > > as routing regular matching, gray-scale publishing, and plug-in metadata. > > 3. The new Apache APISIX documentation website introduces Apache APISIX > > through installation, deployment, quick start, concept introduction, > > plug-ins, debugging, best practices, custom development, etc. > > 4. One command line to install and experience Apache APISIX and > dashboard, > > no more complicated dependencies. Of course this only applies to > > experience. > > 5. Add user cases and recommended deployment modes to the Apache APISIX > > website to enrich the content of the website. > > > > What do you think? > > > > Thanks, > > Ming Wen, Apache APISIX PMC Chair > > Twitter: _WenMing > > > > > -- > > *MembPhis* > My GitHub: https://github.com/membphis > Apache APISIX: https://github.com/apache/apisix >
