Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Update the documentation for the show_labs_settings parameter #9395

Merged
merged 1 commit into from
Oct 12, 2022

Conversation

dhenneke
Copy link
Contributor

@dhenneke dhenneke commented Oct 12, 2022

The parameter is actually called show_labs_settings but the documentation claims it is showLabsSettings.

Checklist

  • Tests written for new code (and old code if feasible)
  • Linter and other CI checks pass
  • Sign-off given on the changes (see CONTRIBUTING.md)

This change is marked as an internal change (Task), so will not be included in the changelog.

The parameter is actually called `show_labs_settings` but the documentation claims it is `showLabsSettings`.

Signed-off-by: Dominik Henneke <[email protected]>
@Fox32
Copy link
Contributor

Fox32 commented Oct 12, 2022

Btw, this also affects the element-web repository: https://github.com/vector-im/element-web/search?q=showLabsSettings

But we aren't sure if it should really be disabled in the normal app.

@turt2live turt2live added the T-Task Refactoring, enabling or disabling functionality, other engineering tasks label Oct 12, 2022
Copy link
Member

@turt2live turt2live left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Due to #8062 it shouldn't matter too much, but definitely good to use the correct one in documentation.

I believe all the usages in element-web and desktop are within build config files - we should probably update them too, but that's significantly lower priority than documentation imo.

@turt2live turt2live merged commit ae883bb into matrix-org:develop Oct 12, 2022
@dhenneke
Copy link
Contributor Author

Thanks! Due to #8062 it shouldn't matter too much, but definitely good to use the correct one in documentation.

So you mean it should actually work if someone puts the value into the config? If yes, then that doesn't work in our installation because the labs section is still displayed with showLabsSettings: false.

I'm not sure how it should be on https://app.element.io. Looking on this file, it should also be hidden there. But it is actually displayed. But it also might be correct that way.

@dhenneke dhenneke deleted the dhenneke-patch-1 branch October 12, 2022 18:15
@t3chguy
Copy link
Member

t3chguy commented Oct 12, 2022

The setting does not impact the tab if Betas are visible. It controls whether the wall of labs flags is shown:

image

@dhenneke
Copy link
Contributor Author

The setting does not impact the tab if Betas are visible. It controls whether the wall of labs flags is shown:

Thanks for the clarification. I confused the two things since the setting name appears to me to hide everything around labs. So if we completely want to hide the "Labs" section in the settings I assume that we need to manually disable the beta features in the config(?).

@t3chguy
Copy link
Member

t3chguy commented Oct 13, 2022

@dhenneke yes. If you explicitly disable all active betas then and either omit show_labs_settings or specify it to false then the section should cease to be

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
T-Task Refactoring, enabling or disabling functionality, other engineering tasks Z-Community-PR Issue is solved by a community member's PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants