apache / apache/apisix-ingress-controller

Discuss: redesign documentation

Open
#1,673 6 comments 1 reaction 0 assignees View on GitHub
discuss documentation
Dominant language
Go
Stars
1.1k
Forks
390
Avg merge
3d 7h
Merged PRs (30d)
12

Description

![ingress-docs](https://user-images.githubusercontent.com/3264292/219263975-1a6b45b1-0ca7-463d-b61f-54265b68909c.png)

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.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the current documentation structure and the proposed structure shown in the issue image. The discussion needs agreement on the desired organization and scope before implementation can begin; done means an agreed redesign with the documentation changes identified.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.