spacewander commented on PR #7262: URL: https://github.com/apache/apisix/pull/7262#issuecomment-1166515445
> @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. -- 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: notifications-unsubscr...@apisix.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
