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

Undocumented settings in config.json #4253

Open
amyblais opened this issue Jan 20, 2021 · 3 comments
Open

Undocumented settings in config.json #4253

amyblais opened this issue Jan 20, 2021 · 3 comments
Labels
Acknowledged/Docs team Issue acknowledged by Docs team, next step pending Needs Documentation

Comments

@amyblais
Copy link
Member

amyblais commented Jan 20, 2021

I believe these settings should be documented:

In the ServiceSettings area:
EnableAWSMetering
SplitKey
FeatureFlagSyncIntervalSeconds
DebugSplit
CollapsedThreads

In the LogSettings area:
EnableSentry

In the ExperimentalAuditSettings:
AdvancedLoggingConfig (NOTE, the addition of this item in the LogSettings section is documented)

In the SupportSettings area:
EnableAskCommunityLink

In the AnnoucementSettings area:
NoticesURL
NoticesFetchFrequency
NoticesSkipCache

In the ExperimentalSettings area:
CloudUserLimit
CloudBilling

In the MessageExportSettings area:
DownloadExportResults

In the Plugins area:
BotUserID

The entire CloudSettings area, to include CWSUrl
The entire FeatureFlags area to include TestFeature, TestBoolFeature, and CloudDelinquentEmailJobsEnabled

More details at https://forum.mattermost.org/t/undocumented-settings-in-config-json-on-5-31/11132/4 on other settings that I believe are already documented or don't need documentation.

@amyblais
Copy link
Member Author

Updated the description based on my investigation ^

@cwarnermm cwarnermm added the Acknowledged/Docs team Issue acknowledged by Docs team, next step pending label Jan 18, 2022
@cwarnermm cwarnermm removed their assignment Jan 18, 2022
@cwarnermm
Copy link
Member

@wiersgallak - Would the PM team be open to reviewing this list of undocumented config settings and identify ones that should be added to the product documentation, please?

@TwizzyDizzy
Copy link

TwizzyDizzy commented Jul 29, 2022

Hi there,

it seems SqlSettings / MigrationsStatementTimeoutSeconds is also missing in the documentation.

EDIT: and it seems quite a few options under FeatureFlags are not documented either.

Cheers
Thomas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Acknowledged/Docs team Issue acknowledged by Docs team, next step pending Needs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants