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.

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

Help Wanted: Document New Client Configuration Property #7453

Open
cwarnermm opened this issue Oct 8, 2024 · 2 comments · May be fixed by #7489
Open

Help Wanted: Document New Client Configuration Property #7453

cwarnermm opened this issue Oct 8, 2024 · 2 comments · May be fixed by #7489
Assignees
Labels
Area/Documentation Improvements Improvements to documentation Difficulty/1:Easy Good First Issue Suitable for first-time contributors Hacktoberfest null Help Wanted Community help wanted Tech/RST

Comments

@cwarnermm
Copy link
Member

cwarnermm commented Oct 8, 2024

Context

mattermost/mattermost-mobile#8220 introduces a new client configuration property that determines whether the mobile app should use the default external browser to perform SSO Authentication instead of the internal one.

Documentation Ask

Source file: configure/site-configuration-settings.rst

Within the Customization section, add the new configuration setting (and its associated search metadata located directly above a section title) as a new section on this page.

Position the new configuration setting immediately following the App custom URL schemes section, and format the details of the section modelled after the report a problem configuration setting.

Include the following configuration setting details:

  • Section title: Mobile external browser
  • Available only for self-hosted deployments
  • Description: Configures the mobile app to perform SSO Authentication using the external default browser.
  • String input.
  • System Config path: N/A
  • config.json = NativeAppSettings -> MobileExternalBrowser
  • Environment variable = MM_NATIVEAPPSETTINGS_MOBILEEXTERNALBROWSER

QA Validation Criteria

In a generated docs preview:

  • Searching for the new configuration setting returns the correct details.
  • Visiting the docs page directly returns details about the new configuration setting.
@cwarnermm cwarnermm added Hacktoberfest null Help Wanted Community help wanted Good First Issue Suitable for first-time contributors Area/Documentation Improvements Improvements to documentation Up for Grabs Difficulty/1:Easy Tech/RST labels Oct 8, 2024
@Rutam21
Copy link
Contributor

Rutam21 commented Oct 10, 2024

@cwarnermm I would like to work on this. Please assign this to me. Thanks.

@cwarnermm
Copy link
Member Author

Thanks, @Rutam21!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area/Documentation Improvements Improvements to documentation Difficulty/1:Easy Good First Issue Suitable for first-time contributors Hacktoberfest null Help Wanted Community help wanted Tech/RST
Projects
None yet
2 participants