The help page for 'automatic upgrades' does not tell one how to re-enable them
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 327
- Forks
- 653
- PR merge metrics
- No merged PRs in 30d
Description
What happened
I saw this:
So I clicked the help button in order to see why how to re-enable automatic upgrades. The resulting webpage did not disclose that information. Surely it should do.
(It took me a while to locate - or, given that I had disabled the setting myself, some time ago - re-locate the information. In order to help others, let me note the procedure here. Syncthing GUI -> Actions -> Advanced Configuration ->Auto upgrade interval (hours) -> set to something other than zero. And there does turn out to be a relevant help page.)
What I expected to happen
I expected to see a help page that discloses how to enable and disable automatic updates.
Version Information
Syncthing Version: 1.23.7
The OS of the computer at issue
Windows 10 Pro - 22H2 (2009: 19045)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the help page reached from the automatic-upgrades setting and compare it with the configuration reference at docs.syncthing.net/v1.23.6/users/config#config-option-options.autoupgradeintervalh. Update the relevant documentation so it explains both disabling and re-enabling automatic upgrades via Auto upgrade interval (hours), then verify the help link presents that procedure.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100