Skip to content

Conversation

@cwarnermm
Copy link
Member

This PR addresses issue #8155 by migrating the compliance configuration settings documentation to match the standard format used by other configuration settings pages.

Changes Made:

  • Updated all configuration settings to use standardized two-column table format
  • Replaced old single-column tables with new format matching other config files
  • Maintained all existing config:setting directives
  • Ensures consistent documentation structure across all configuration pages

Fixes #8155

Generated with Claude Code

- Updated all configuration settings to use standardized two-column table format
- Replaced old single-column tables with new format matching other config files
- Maintained all existing config:setting directives
- Ensures consistent documentation structure across all configuration pages

Fixes #8155

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
@cwarnermm cwarnermm added the 2: Editor Review Requires review by an editor label Jul 7, 2025
@github-actions
Copy link

github-actions bot commented Jul 7, 2025

Newest code from mattermost has been published to preview environment for Git SHA 9178165

@github-actions
Copy link

github-actions bot commented Jul 8, 2025

Newest code from mattermost has been published to preview environment for Git SHA 10a0a5f

@cwarnermm
Copy link
Member Author

Next steps:

  • Incorporate default & possible values
  • Ensure caveats are formatted as notes below each table
  • Review search metadata

@cwarnermm
Copy link
Member Author

Message/File Retention

  • MessageRetentionHours: Default 0, must be ≥ 0
  • FileRetentionHours: Default 0, must be ≥ 0
  • Custom retention policy: API-managed with display_name and
    post_duration
  • DeletionJobStartTime: Default "02:00", format "15:04"

Message Export

  • EnableExport: Default false
  • DailyRunTime: Default "01:00", format "15:04"
  • ExportFormat: Default "actiance", values: "actiance", "globalrelay",
    "globalrelay-zip", "csv"

GlobalRelay Settings

  • CustomerType: Default "A9", values: "A9", "A10", "CUSTOM"
  • SmtpUsername: Default "" (empty)
  • SMTPPassword: Default "" (empty)
  • EmailAddress: Default "", must contain "@"
  • CustomSMTPServerName: Default "", required if CustomerType is "CUSTOM"
  • CustomSMTPPort: Default "25", required if CustomerType is "CUSTOM"

Batch Sizes

  • BatchSize (Data Retention): Default 3000
  • BatchSize (Message Export): Default 10000
  • BatchSize (Compliance Reports): Default 30000

Compliance Settings

  • ComplianceSettings.Enable: Default false
  • ComplianceSettings.Directory: Default "./data/"
  • ComplianceSettings.EnableDaily: Default false
  • ComplianceSettings.BatchSize: Default 30000

Terms of Service

  • CustomTermsOfServiceEnabled: Default false
  • CustomTermsOfServiceReAcceptancePeriod: Default 365 days

All settings are found in server/public/model/config.go and require
enterprise licensing (E20) for most compliance features.

@github-actions
Copy link

github-actions bot commented Jul 8, 2025

Newest code from mattermost has been published to preview environment for Git SHA ca924c5

@cwarnermm
Copy link
Member Author

@claude - Incorporate default & possible values for each configuration setting as defined via #8164 (comment)

@claude
Copy link
Contributor

claude bot commented Jul 10, 2025

Claude finished @cwarnermm's task —— View job


✅ Successfully incorporated default & possible values for configuration settings

Todo List:

  • Read current compliance configuration file
  • Analyze detailed comment with defaults and possible values
  • Update RST file with default values and possible values
  • Test/lint documentation if tools available (skipped - no bash permissions)
  • Commit and push changes

🎯 Summary of Changes:

Successfully added default values, constraints, and possible values to all compliance configuration settings based on the detailed requirements provided in the comment. The documentation now includes:

Message/File Retention: Added defaults for MessageRetentionHours (0), FileRetentionHours (0), and DeletionJobStartTime ("02:00")

Message Export: Added defaults for EnableExport (false), DailyRunTime ("01:00"), and ExportFormat ("actiance" with possible values)

GlobalRelay Settings: Added defaults for CustomerType ("A9"), username/password (empty), EmailAddress (empty with @ constraint), and SMTP settings

Batch Sizes: Added defaults for all batch size settings (3000, 10000, 30000)

Compliance Settings: Added defaults for Enable (false), Directory ("./data/"), EnableDaily (false), and BatchSize (30000)

Terms of Service: Added defaults for CustomTermsOfServiceEnabled (false) and ReAcceptancePeriod (365 days)

📋 Format Enhancements:

  • Added **Default**: value entries for all settings
  • Added **Constraints**: requirements where applicable
  • Added **Options**: possible values for enum-type settings
  • Added **Format**: specification for structured inputs
  • Added **Required**: conditions for conditional settings

The changes have been committed and pushed to the claude/issue-8155-20250707_201524 branch. The compliance configuration settings documentation now provides comprehensive default values and possible values for all configuration options as requested.

@github-actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 320fef4

Enhanced all configuration settings in the compliance section with:
- Default values for each setting
- Constraints and validation rules where applicable
- Possible values/options for enum-type settings
- Format specifications for structured inputs

This improves documentation clarity and helps users understand expected values and formats.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: Claude <[email protected]>
Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
@github-actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA e9c5a8f

@github-actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 9cd9c8e

@github-actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 77fe4f1

@github-actions
Copy link

Newest code from mattermost has been published to preview environment for Git SHA 4239259

@cwarnermm cwarnermm changed the title Migrate compliance config settings to standard format DocsBrokenWindow: Migrate compliance config settings to standard format Oct 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2: Editor Review Requires review by an editor Guidance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs Broken Window: Migrate compliance config settings to new format

2 participants