Skip to content

Add application setting developer documentation

What does this MR do and why?

Whenever I wanted to add an application setting, I looked up some MR that did it before and go through all the files that need to change.

Reviewing MRs that add application settings, I sometimes found that the API documentation wasn't updated or a validation or default value was missing.

I think it would be helpful to provide some more guidance for developers about application settings.

How to set up and validate locally

  1. Visit http://localhost:3000/help/development/application_settings.html

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports