Refactor config.json settings tables in configuration-settings.rst files to remove horizontal bars #7549
Conversation
…les to remove horizontal bars
|
Hello @guruprasath-v, Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here. |
cwarnermm
added
2: Editor Review
|
@guruprasath-v - Please resolve your merge conflicts in this PR. |
cwarnermm
added
preview-environment
|
Newest code from guruprasath-v has been published to preview environment for Git SHA e89f2a9 |
There was a problem hiding this comment.
@guruprasath-v - This is an outstanding docs PR that was a BIG lift to complete. Well done and thank you! I've provided editorial and reviewer feedback inline.
In most cases, I've simply removed the bullet point formatting in cases where it isn't needed or preferred.
Please perform a second review looking for any places where there's a single text line note that's currently formatted as a bullet and remove the bullet for consistency.
In a few cases, I've flagged some notes that should be converted to formatted notes/warnings.
| | a single sign-on (SSO) service to create accounts. | - Environment variable: ``MM_EMAILSETTINGS_ENABLESIGNUPWITHEMAIL`` | | ||
| +-----------------------------------------------------------------------------------------------+--------------------------------------------------------------------------+ | ||
| .. note:: | ||
| - Cloud admins can't modify this configuration setting. |
There was a problem hiding this comment.
| - Cloud admins can't modify this configuration setting. | |
| Cloud admins can't modify this configuration setting. |
| +-----------------------------------------------------------------------------+-------------------------------------------------------------------------+ | ||
|
|
||
| .. note:: | ||
| - To provide users with only a single email sign in option on the login page, ensure that the |
There was a problem hiding this comment.
| - To provide users with only a single email sign in option on the login page, ensure that the | |
| To provide users with only a single email sign in option on the login page, ensure that the |
| | - **false**: Hides the **Forgot Password** link from the Mattermost login page. | - Environment variable: ``MM_LDAPSETTINGS_FORGOTPASSWORDLINK`` | | ||
| +---------------------------------------------------------------------------------+----------------------------------------------------------------------------------+ | ||
| .. note:: | ||
| - You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. |
There was a problem hiding this comment.
| - You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. | |
| You can customize the **Forgot Password** link URL by going to **Site Configuration > Customization > Forgot Password Custom Link**. |
| | - **false**: **(Default)** Disables previews of SVG files. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableSVGs`` > ``false``| | ||
| | | - Environment variable: ``MM_SERVICESETTINGS_ENABLESVGS`` | | ||
| +-------------------------------------------------------------------------------+----------------------------------------------------------------------------+ | ||
| | **Warning**: Enabling SVGs is not recommended in environments where not all users are trusted. | |
There was a problem hiding this comment.
Please turn this into a formatted warning using .. warning::
| | - **false**: **(Default)** Disables rendering in blocks. Instead, LaTeX code is highlighted. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableLatex`` > ``false``| | ||
| | | - Environment variable: ``MM_SERVICESETTINGS_ENABLELATEX`` | | ||
| +----------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------+ | ||
| | **Warning**: Enabling LaTeX rendering is not recommended in environments where not all users are trusted. | |
There was a problem hiding this comment.
Please turn this into a formatted warning
| | - **false**: **(Default)** Disables inline rendering of LaTeX. Instead, LaTeX in message text is highlighted. | - ``config.json`` setting: ``ServiceSettings`` > ``EnableInlineLatex`` > ``false`` | | ||
| | LaTeX can also be rendered in a code block, if that feature is enabled. See **Enable LaTeX code block rendering**. | - Environment variable: ``MM_SERVICESETTINGS_ENABLEINLINELATEX`` | | ||
| +-------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ | ||
| | **Warning**: Enabling LaTeX rendering isn't recommended in environments where not all users are trusted. | |
There was a problem hiding this comment.
Please turn this into a formatted warning
| - The key must have the YouTube Data API added as a service. | ||
| - This key is used in client-side Javascript. |
There was a problem hiding this comment.
| - The key must have the YouTube Data API added as a service. | |
| - This key is used in client-side Javascript. | |
| - This key is used in client-side Javascript, and must have the YouTube Data API added as a service. |
|
Hello @cwarnermm, I've made the changes as per your feedback, but I had a couple of questions to clarify:
Thanks for clarifying! |
|
Hi @guruprasath-v - Yes, please remove the bullet formatting that you flagged above. Thank you for finding those additional cases. Please also apply the updates flagged inline above, if you haven't already, starting from #7549 (comment) |
- Removed single-item bullets and adjusted formatting as per feedback - Converted flagged notes into formatted notes/warnings where specified - Completed all inline updates as per review comments
- Removed single-item bullets and adjusted formatting as per feedback - Converted flagged notes into formatted notes/warnings where specified - Completed all inline updates as per review comments
|
Ma'am, @cwarnermm, I have made all the changes and pushed them to the previous PR. Please check and let me know if any further changes are needed. |
|
/update-branch |
|
Error trying to update the PR. |
cwarnermm
added
preview-environment
|
Newest code from guruprasath-v has been published to preview environment for Git SHA 9ddcb90 |
There was a problem hiding this comment.
Thank you, @guruprasath-v!! Really appreciate your help with this docs issue.
cwarnermm
added
3: Reviews Complete
|
Hi Ma'am @cwarnermm! Super excited to see our PR merged! Out of curiosity, would this contribution qualify for the Mattermost limited edition mug? 😊 |
|
This is your first Mattermost contribution, isn't it, @guruprasath-v? Yes! First contributions to any Mattermost project area, including documentation, earns you a Mattermost limited edition mug. Thank you again for your hard work on this issue! |
Summary
This PR refactors the configuration tables in various
.rstfiles to align with the Mattermost documentation style guide by eliminating horizontal bars in tables.Changes Made
config.jsonentries to the format"Setting" > "Subsetting"across key.rstfiles, which prevents unwanted horizontal bars and improves readability... note::tags to ensure clarity and consistency.Files Updated
source/configure/authentication-configuration-setttings.rstsource/configure/site-configuration-settings.rstsource/configure/plugins.configuration-settings.rstsource/configure/environment-configuration-settings.rst: Updated one table entry, as most of the documented tables were not present in the codebase.Additional Information
These changes address all configuration settings found with table format issues, while other configuration files were not modified as they did not contain tables needing refactoring.