Bug #6590
Updated by Brett Smith almost 9 years ago
In the API server installation guide: # Under the header "Configure the API server," near the end of the discussion explaining @application.yml@ and @application.default.yml@, add a new paragraph that explains: #* This section of the documentation highlights settings that you must, or will likely want to change for your installation. #* @application.default.yml@ includes comments that explain each setting in more detail, including settings not documented here that are less frequently changed. # Similar to the existing subsections for specific settings, add notes explaining the following settings users are likely to want to change: #* websockets_address #* git_internal_dir In @application.default.yml@, move settings that are more likely to be changed, along with their documenting comments, nearer the top of the file; and settings less likely to be changed nearer the bottom. Don't sweat the exact order too much. You can think of them in three basic buckets: administrator must set this; administrator may be interested in changing this; administrator is unlikely to want to change this.