users/versioning: Document versioning config parameters #813
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current text talks about configuring the location of the versions folder (from the default .stversions) only in context of the staggered strategy. In fact, all but external versioning do support this configuration now.
Add descriptions for all of the <versioning> config sub-elements. Move some detailed info from the overall description into the respective option reference. Use stconf: as default domain for shorter option cross-references and text roles.
Mention the applicable config options for each versioning strategy in the text, linked to the option reference. Rewrap changed paragraphs for a maximum width of 80 characters. Two spaces after each full stop.
👷 Deploy request for syncthing-docs pending review.Visit the deploys page to approve it
|
calmh
approved these changes
Aug 9, 2023
tomasz1986
added a commit
to tomasz1986/docs
that referenced
this pull request
Aug 16, 2023
…up (syncthing#813) The option "restartOnWakeup" was removed in Syncthing v1.21.0 [1]. Thus, remove it from the Docs too, as it is no longer functional and may confuse new users [2]. [1] syncthing/syncthing#8448 [2] syncthing/syncthing-android#1961 Signed-off-by: Tomasz Wilczyński <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
After some tedious research in the GUI and backend code, this hopefully covers all applicable parameters for each versioning strategy. Some factual errors and outdated information are also updated.
This kind of mixes up the config file reference part with the user-facing overall description of the versioning mechanism. However, the same blurry distinction applies to the users/config chapter overall. I've tried to keep it mostly readable by collecting the option reference list at the end under a separate heading.