Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

complete configuration options explanation #11014

Closed
kostmetallist opened this issue Oct 1, 2019 · 5 comments
Closed

complete configuration options explanation #11014

kostmetallist opened this issue Oct 1, 2019 · 5 comments
Labels
A-Documentation T-Enhancement

Comments

@kostmetallist
Copy link

kostmetallist commented Oct 1, 2019 •
edited
Loading

It is kinda hard for non-experienced developer to deal with new software especially when there is minimum information about how does it work. I find config doc for Riot not very descriptive. For example, there are no explanation for enable_presence_by_hs_url and hosting_signup_link options at all while in sample JSON config (https://riot.im/develop/config.json) these elements are presented. My suggestion is to improve Riot configuration documentation.
@abrenoch
Copy link

I'm honestly not sure if enable_presence_by_hs_url does anything at all. If you search the entire codebase of this project the only place that shows up is in sample config files...

@turt2live turt2live mentioned this issue Mar 10, 2020
Closed
@rubo77
Copy link
Contributor

rubo77 commented Jul 15, 2020 •
edited
Loading

Now there is an explanation in https://github.com/vector-im/riot-web/blob/master/docs/config.md :

  1. enable_presence_by_hs_url: The property key should be the URL of the homeserver and its value defines whether to enable/disable the presence status display from that homeserver. If no options are configured, presence is shown for all homeservers.

But what exactly does that mean? for a not experienced user this is still not clear. What is the "presence status"?

@aaronraimist
Copy link
Collaborator

People who aren't experienced shouldn't be editing config.json anyway.

@rubo77
Copy link
Contributor

rubo77 commented Jul 16, 2020

Then there should be a section that explains for those, which values are relevant to noon experienced users, for example you should add your Homeserver to the directory

@t3chguy
Copy link
Member

t3chguy commented Jun 7, 2022

This got done, the doc is much better now https://github.com/vector-im/element-web/blob/develop/docs/config.md

@t3chguy t3chguy closed this as completed Jun 7, 2022
su-ex added a commit to SchildiChat/element-web that referenced this issue Feb 22, 2024
@su-ex
Merge tag 'v1.11.34' into sc
6d4220e 
* OIDC: add delegatedauthentication to validated server config ([\element-hq#11053](matrix-org/matrix-react-sdk#11053)). Contributed by @kerryarchibald.
* Allow image pasting in plain mode in RTE ([\element-hq#11056](matrix-org/matrix-react-sdk#11056)). Contributed by @alunturner.
* Show room options menu if "UIComponent.roomOptionsMenu" is enabled ([\element-hq#10365](matrix-org/matrix-react-sdk#10365)). Contributed by @maheichyk.
* Allow image pasting in rich text mode in RTE ([\element-hq#11049](matrix-org/matrix-react-sdk#11049)). Contributed by @alunturner.
* Update voice broadcast redaction to use MSC3912 `with_rel_type` instead of `with_relations` ([\element-hq#11014](matrix-org/matrix-react-sdk#11014)). Fixes element-hq#25471.
* Add config to skip widget_build_url for DM rooms ([\element-hq#11044](matrix-org/matrix-react-sdk#11044)). Fixes vector-im/customer-retainer#74.
* Inhibit interactions on forward dialog message previews ([\element-hq#11025](matrix-org/matrix-react-sdk#11025)). Fixes element-hq#23459.
* Removed `DecryptionFailureBar.tsx` ([\element-hq#11027](matrix-org/matrix-react-sdk#11027)). Fixes element-hq/element-meta#1358. Contributed by @florianduros.
* Fix translucent `TextualEvent` on search results panel ([\element-hq#10810](matrix-org/matrix-react-sdk#10810)). Fixes element-hq#25292. Contributed by @luixxiul.
* Matrix matrix scheme permalink constructor not stripping query params ([\element-hq#11060](matrix-org/matrix-react-sdk#11060)). Fixes element-hq#25535.
* Fix: "manually verify by text" does nothing ([\element-hq#11059](matrix-org/matrix-react-sdk#11059)). Fixes element-hq#25375. Contributed by @kerryarchibald.
* Make group calls respect the ICE fallback setting ([\element-hq#11047](matrix-org/matrix-react-sdk#11047)). Fixes vector-im/voip-internal#65.
* Align list items on the tooltip to the start ([\element-hq#11041](matrix-org/matrix-react-sdk#11041)). Fixes element-hq#25355. Contributed by @luixxiul.
* Clear thread panel event permalink when changing rooms ([\element-hq#11024](matrix-org/matrix-react-sdk#11024)). Fixes element-hq#25484.
* Fix spinner placement on pinned widgets being reloaded ([\element-hq#10970](matrix-org/matrix-react-sdk#10970)). Fixes element-hq#25431. Contributed by @luixxiul.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Documentation T-Enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@rubo77 @abrenoch @t3chguy @aaronraimist @kostmetallist