This repository was archived by the owner on Apr 26, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Document configuration option vocabulary/taxonomy and then simplify #5584
Copy link
Copy link
Open
Labels
A-Docsthings relating to the documentationthings relating to the documentationO-OccasionalAffects or can be seen by some users regularly or most users rarelyAffects or can be seen by some users regularly or most users rarelyS-MinorBlocks non-critical functionality, workarounds exist.Blocks non-critical functionality, workarounds exist.T-TaskRefactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.
Description
A document that contains the vocabulary of the synapse configuration and the expected values of those named fields would assist in keeping code consistent.
A few things have popped up recently, here and in other branches, so I thought i'd start an issue to collect examples.
I think we should first generate a statement on what the best naming scheme is for things, aim to apply that in future, then come back and deprecate/rename existing options to bring them into line.
Related issues:
- Rename
email.riot_base_url
config option #3913 (we should be clear this is used as a prefix or a template) - Document the notif_from config parameter #2326 (we should be clear on what is a template and what isn't)
- Account for slash at the end of
url
in appservice config file #3523 (we should be consistent in requiring and handling trailing slashes in URLs in our configuration)
ptman, abeluck and Supersonic112
Metadata
Metadata
Assignees
Labels
A-Docsthings relating to the documentationthings relating to the documentationO-OccasionalAffects or can be seen by some users regularly or most users rarelyAffects or can be seen by some users regularly or most users rarelyS-MinorBlocks non-critical functionality, workarounds exist.Blocks non-critical functionality, workarounds exist.T-TaskRefactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.Refactoring, removal, replacement, enabling or disabling functionality, other engineering tasks.