HipChat Windows: Hipchat.ini Documentation Improvement

Overview

For now, we only have the following documentations / KB that explains about Hipchat.ini, the configuration file that is created after a user logs in to the desktop client (Windows & Linux):

• Windows / Linux Configuration File
• Hipchat Mac/Linux/Windows 4.x apps throw "Make sure you have an internet connection and try again"

Apart from knowing the location of the file:

• Windows: C:\Users\<user>\AppData\Roaming\Atlassian\Hipchat.ini
• Linux: /home/<user>/.config/Atlassian/Hipchat.ini

The lack of details of what can be done with the file can be frustrating for users who would like to understand what each parameter means and other additional details that can be included there. For example:

[General]
blinkTaskbar=true
enableIdle=true
idleMinutes=15
isLoginDataEncrypted=true
keepToasterNotificationsVisible=false
lastServerUrl=https://hipchat.example.com
lastWindowDPI=96
notificationType=1
soundEnabled=true
spellCheckEnabled=true
verboseLogging=false
windowGeometry=@Rect(134 106 1237 768)
windowMaximized=false
zoomFactor=1

Suggestion

Since we already have the official documentation ready - Windows / Linux Configuration File, we improve it by including more details to what each parameter does and the values. For example:

• lastServerUrl: The FQDN of the HipChat Server / Data Center that you logged in to. For example: https://hipchat.example.com
• spellCheckEnabled: Enable spell checking for the text you typed. Default: true. Other value(s): false