[doc] apparent typo in the documentation of GitHub release check option

[rapidcow]

As of v0.20.0, the option that controls whether HomeBox checks for the latest GitHub release is spelled GithubReleaseCheck in the Go backend code:

type Options struct {
	AllowRegistration    bool   `yaml:"disable_registration"    conf:"default:true"`
	AutoIncrementAssetID bool   `yaml:"auto_increment_asset_id" conf:"default:true"`
	CurrencyConfig       string `yaml:"currencies"`
	GithubReleaseCheck   bool   `yaml:"check_github_release"    conf:"default:true"`
	AllowAnalytics       bool   `yaml:"allow_analytics"         conf:"default:false"`
}

I loosely traced this back to PR#442, merged in commit 9cf244c9 (tags/v0.17.0~3), which instead documents this option / environment variable as --options-check-github-release / HBOX_OPTIONS_CHECK_GITHUB_RELEASE. (Note the reversed order of the verb.)

diff --git a/docs/en/configure-homebox.md b/docs/en/configure-homebox.md
index c2d2db69..e014080f 100644
--- a/docs/en/configure-homebox.md
+++ b/docs/en/configure-homebox.md
@@ -25,7 +25,7 @@
 | HBOX_MAILER_FROM                     |                                            | email from address to use                                                              |
 | HBOX_SWAGGER_HOST                    | 7745                                       | swagger host to use, if not set swagger will be disabled                               |
 | HBOX_SWAGGER_SCHEMA                  | `http`                                     | swagger schema to use, can be one of: `http`, `https`                                  |
-
+| HBOX_OPTIONS_CHECK_GITHUB_RELEASE    | true                                       | check for new github releases                                                          |
 
 ::: tip "CLI Arguments"
 If you're deploying without docker you can use command line arguments to configure the application. Run `homebox --help` for more information.
@@ -55,6 +55,7 @@ OPTIONS
 --options-allow-registration/$HBOX_OPTIONS_ALLOW_REGISTRATION            <bool>    (default: true)
 --options-auto-increment-asset-id/$HBOX_OPTIONS_AUTO_INCREMENT_ASSET_ID  <bool>    (default: true)
 --options-currency-config/$HBOX_OPTIONS_CURRENCY_CONFIG                  <string>
+--options-check-github-release/$HBOX_OPTIONS_CHECK_GITHUB_RELEASE        <bool>    (default: true)
 --help/-h    display this help message
 ```
 :::

This appears to be inconsistent with the help message that the conf package generated in both the commit it was added in (reproduced below in Linux with the Bash shell) and in the live instance I deployed on my VPS (v0.20.0):

$ git switch -d tags/v0.17.0~3
HEAD is now at 9cf244c9 Add a warning when the version does not match the latest release (#442)
$ cd backend
$ go build -o api app/api/*.go
[ output omitted ]
$ ./api --help
Usage: api [options] [arguments]

OPTIONS
  [ other options omitted ]
  --options-github-release-check/$HBOX_OPTIONS_GITHUB_RELEASE_CHECK        <bool>      (default: true)
  [ other options omitted ]

My conclusion from this observation is that the erroneous help message in the documentation was derived from a version of the source code that had spelled the variable as CheckGithubRelase instead of GithubReleaseCheck.

I should emphasize that live documentation retains this spelling, so this discrepancy has not been addressed and continues to be relevant in the present versions (v0.20.0 and on).

In short, either the documentation is wrong (and thus the option should be HBOX_OPTIONS_GITHUB_RELEASE_CHECK) or the code is misspelled (and thus the Options struct member should be renamed to CheckGithubRelase). I'm curious to know which one is the intention of the author (since to me, putting the verb first actually feels more natural. :)

And just to make it clear, I would be happy to help update the Markdown documentation or the backport Go code change. I just need to know which option people prefer first since there are two options at hand and both options fairly reasonable to me.

[tonyaellie]

I do not remember what my original intention was but i think the best fix now is to update the docs to match the implementation.

[rapidcow]

I just compared the help message and the documentation at HEAD and there seem to be at least one more mismatched variable (HBOX_WEB_MAX_UPLOAD and --web-max-file-upload / $HBOX_WEB_MAX_FILE_UPLOAD (in the CLI Arguments block) becomes --web-max-upload-size / $HBOX_WEB_MAX_UPLOAD_SIZE). Maybe we can fix them all at once. :)

[rapidcow]

Ok -- I made a pull request so I think I will mark your reply as answer to "close" this thing...