docs: Add configuration docs for apisix and env variables

[avinal]

Description

• Added Configuration chapter
• Added environment variables docs
• Added docs for apisix in conf/config-default.yaml
• Partially solves #6611

Checklist

• [x] I have explained the need for this PR and the problem it solves
• [x] I have explained the changes or the new features added to this PR
• [ ] I have added tests corresponding to this change
• [x] I have updated the documentation to reflect this change
• [x] I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

Signed-off-by: Avinal Kumar [email protected]

[avinal]

I have added all the options under apisix in the default config YAML. Please let me know if something is missing. Please review: @juzhiyuan @navendu-pottekkat @tzssangglass

[juzhiyuan]

👋 Hi, please also add the missing category :)

[spacewander]

The new doc is quite confusing...

For example, it is very hard to figure out that the boolean is applied to the stream_proxy.only.

Can we add the comment in a reference of yaml, like https://github.com/elastic/beats/blob/master/filebeat/filebeat.reference.yml?

[avinal]

@spacewander are you suggesting that the YAML file should be updated? FYI I am working on how can I make them more obvious so that people don't get confused with other options.

[spacewander]

@spacewander are you suggesting that the YAML file should be updated? FYI I am working on how can I make them more obvious so that people don't get confused with other options.

I would suggest using a yaml code block in the doc. The yaml code will be a detailed commented version of config-default.yaml like the https://github.com/elastic/beats/blob/master/filebeat/filebeat.reference.yml

There are the benefits:

1. straightforward
2. easy to sync
3. consistent render behavior

As APISIX is an open-source project, it would be great to reduce the requirement to update the doc so that contributors can update the doc themselves. Otherwise, the maintenance burden would be too heavy.

Also, a 100% mirrored config-default.yaml is easier for the users to refer to.

[avinal]

I am looking into alternative methods that will be easy to maintain as well as easy to read. May take some time. Thanks

[github-actions[bot]]

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the [email protected] list. Thank you for your contributions.

[avinal]

I apologize for the long delay, Please review. I have addressed all the comments.

[github-actions[bot]]

This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the [email protected] list. Thank you for your contributions.

[github-actions[bot]]

This pull request/issue has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.