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.

Sign up for GitHub

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

Jump to bottom

Update data-retention-policy.rst #4937

Merged
merged 21 commits into from
Aug 11, 2021
Merged

Update data-retention-policy.rst #4937

merged 21 commits into from
Aug 11, 2021

Conversation

wiersgallak
Copy link
Contributor

Adding docs for custom data retention policies.

Summary

Ticket Link

@wiersgallak
Update data-retention-policy.rst
80c86a5 
Adding docs for custom data retention policies.
@wiersgallak wiersgallak requested a review from cwarnermm August 6, 2021 21:14
@wiersgallak wiersgallak added the 2: Editor Review Requires review by an editor label Aug 6, 2021
@wiersgallak wiersgallak requested a review from mkraft August 6, 2021 21:14
@wiersgallak wiersgallak added the 1: Dev Review Requires review by a core commiter label Aug 6, 2021
@github-actions
Copy link

github-actions bot commented Aug 6, 2021

Newest code from wiersgallak has been published to preview environment for Git SHA 80c86a5

@amyblais amyblais added this to the v5.38.0 milestone Aug 6, 2021
@github-actions
Copy link

github-actions bot commented Aug 9, 2021

Newest code from wiersgallak has been published to preview environment for Git SHA 6e0aa69

@cwarnermm
Copy link
Member

cwarnermm commented Aug 9, 2021 •
edited
Loading

Thank you so much for this great PR, @wiersgallak!

The introduction contains this line:
"In Mattermost Enterprise E20, you can set a custom policy to manage how long messages and file uploads are kept in Mattermost channels and direct messages."

We should update this as follows:
"In Mattermost Enterprise E20, you can set a global retention policy as well as custom retention policies to manage how long messages and file uploads are kept in Mattermost channels and Direct Messages.

I also recommend changing the Warning located near the top of the page from:
"Once a message or a file is deleted, the action is irreversible. Please use caution when setting up a custom data retention policy."
to:
"Once a message or a file is deleted, the action is irreversible. Please use caution when setting up global or custom data retention policies.

cwarnermm
cwarnermm requested changes Aug 9, 2021
View reviewed changes
Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Thank you for this excellent PR for data retention policies. I've provided suggestions and feedback inline.

source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated
4. Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
2. Select edit from the menu presented to the right of the **Global retention policy** table.
3. Select a **Channel & direct message retention** option from the dropdown. Specify the number of days or years to keep channel and direct messages. When a time is specified, messages, including file attachments, older than the duration you set will be deleted at the specified time. The minimum retention period is one day.
3. Select a **File retention** option from the dropdown. Specify the number of days or ears to keep files. When a time is specified uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage** at the specified time. The minimum retention period is one day.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
3. Select a **File retention** option from the dropdown. Specify the number of days or ears to keep files. When a time is specified uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage** at the specified time. The minimum retention period is one day.
3. Specify a global retention policy for files by selecting a **File retention** option from the dropdown, then specifying how long to keep uploaded files. When a time is specified, uploaded files older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage**) at the specified time. The minimum retention period is one day.

Copy link
Member

Choose a reason for hiding this comment

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

We appear to be making a distinction between file attachments on a channel or DM message versus uploaded files. Is this intentional? If so, we may want to clearly emphasize the difference between the two types of "files" and under what conditions each global retention option will work.

Copy link
Contributor

Choose a reason for hiding this comment

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

the number 3 is used for two different bullet.

Copy link
Contributor

Choose a reason for hiding this comment

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

We appear to be making a distinction between file attachments on a channel or DM message versus uploaded files. Is this intentional? If so, we may want to clearly emphasize the difference between the two types of "files" and under what conditions each global retention option will work.

Every file in the Channels product is attached to a post. The global file policy deletes all files (regardless of whether they're in a direct message, private, or public channel).

source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated
@@ -61,12 +80,6 @@ This usually means another data retention job is in progress. You can verify thi

If no jobs are in progress and the job has stayed ``Pending`` for more than 2 minutes, then you may not have restarted your server after enabling the data retention policy. Restart your server and try again.
Copy link
Member

Choose a reason for hiding this comment

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

Is a server restart required when making global or custom data retention policies?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mkraft Can you confirm if a restart is still required for making changes to the data retention policies?

Copy link
Contributor

Choose a reason for hiding this comment

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

No it's not necessary anymore.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Great Thanks!!

@github-actions
Copy link

Newest code from amyblais has been published to preview environment for Git SHA 6e0aa69

mkraft
mkraft approved these changes Aug 10, 2021
View reviewed changes
Copy link
Contributor

@mkraft mkraft left a comment

Choose a reason for hiding this comment

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

At some point we could ask ourselves to what extent we need to documenting seemingly obvious user-experience steps. For example:

Go to System Console > Compliance > Data Retention Policy.

or

select Edit to specify the start time of the daily scheduled data retention job

I just wonder if future documents like this could only contain the non-obvious descriptions, gotchas and implementation details that the UX doesn't outline.

source/comply/data-retention-policy.rst Outdated
4. Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
2. Select edit from the menu presented to the right of the **Global retention policy** table.
3. Select a **Channel & direct message retention** option from the dropdown. Specify the number of days or years to keep channel and direct messages. When a time is specified, messages, including file attachments, older than the duration you set will be deleted at the specified time. The minimum retention period is one day.
3. Select a **File retention** option from the dropdown. Specify the number of days or ears to keep files. When a time is specified uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage** at the specified time. The minimum retention period is one day.
Copy link
Contributor

Choose a reason for hiding this comment

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

the number 3 is used for two different bullet.

source/comply/data-retention-policy.rst Outdated
4. Set the start time of the daily scheduled data retention job. Choose a time when fewer people are using your system. Must be a 24-hour time stamp in the form HH:MM.
2. Select edit from the menu presented to the right of the **Global retention policy** table.
3. Select a **Channel & direct message retention** option from the dropdown. Specify the number of days or years to keep channel and direct messages. When a time is specified, messages, including file attachments, older than the duration you set will be deleted at the specified time. The minimum retention period is one day.
3. Select a **File retention** option from the dropdown. Specify the number of days or ears to keep files. When a time is specified uploaded files which are older than the duration you set will be deleted from your file storage system (either from your local disk or your Amazon S3 service as specified in **System Console > Environment > File Storage** at the specified time. The minimum retention period is one day.
Copy link
Contributor

Choose a reason for hiding this comment

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

We appear to be making a distinction between file attachments on a channel or DM message versus uploaded files. Is this intentional? If so, we may want to clearly emphasize the difference between the two types of "files" and under what conditions each global retention option will work.

Every file in the Channels product is attached to a post. The global file policy deletes all files (regardless of whether they're in a direct message, private, or public channel).

wiersgallak and others added 13 commits August 10, 2021 14:47
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
7c154f7 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
b1d4348 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
60932a2 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
decd55c 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
095d22c 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
ec012b3 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
47a9114 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
4614aef 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
c3a4862 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
74f2d08 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
828fe48 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
3094497 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
40b8f79 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA ec012b3

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 60932a2

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 7c154f7

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 4614aef

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 828fe48

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 3094497

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 74f2d08

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 3094497

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA c3a4862

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 40b8f79

@wiersgallak
Copy link
Contributor Author

@cwarnermm I made some editorial updates again along with addressing your feedback. I felt like we were being a bit redundant and overusing the word "specified". I also removed the sections that indicated a restart was required.

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 80e1d3e

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 09cd4eb

@amyblais amyblais removed the 1: Dev Review Requires review by a core commiter label Aug 11, 2021
@amyblais amyblais requested a review from cwarnermm August 11, 2021 13:15
cwarnermm
cwarnermm approved these changes Aug 11, 2021
View reviewed changes
Copy link
Member

@cwarnermm cwarnermm left a comment

Choose a reason for hiding this comment

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

Thank you for this great docs addition! I've identified a few additional places where we can convert "specified" to "set" for simplicity and to remove unnecessary redundancy.

source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
source/comply/data-retention-policy.rst Outdated Show resolved Hide resolved
@cwarnermm cwarnermm added 3: Reviews Complete All reviewers have approved the pull request and removed 2: Editor Review Requires review by an editor labels Aug 11, 2021
wiersgallak and others added 4 commits August 11, 2021 09:16
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
e2abdfc 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
8574a78 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
cb54853 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@wiersgallak @cwarnermm
Update source/comply/data-retention-policy.rst
f4484d2 
Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>
@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA e2abdfc

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA 8574a78

@wiersgallak wiersgallak merged commit 5cb1f23 into v5.38-documentation Aug 11, 2021
@wiersgallak wiersgallak deleted the wiersgallak-patch-2 branch August 11, 2021 14:23
@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA cb54853

@github-actions
Copy link

Newest code from wiersgallak has been published to preview environment for Git SHA f4484d2

amyblais added a commit that referenced this pull request Aug 16, 2021
@cwarnermm @amyblais
@justinegeffen @wiersgallak
V5.38 documentation (#4914)
68d7777 
* Update conf.py

* Update open-source-components.rst

* Update release-lifecycle.rst

* Reliable Websockets: default to true

Documentation for: mattermost/mattermost#17890

Updated:
- Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Experimental Settings only in config.json > Enable Reliable Websockets
   - Updated the default value of the config setting to ``true``

* PR didn't follow internal processes for submission

* Re-added file deleted in error

* Re-added the correct file that was deleted in error

* MM-36779 - Add ChimeraOAuthProxyURL config option (#4928)

* MM-36779 - Add ChimeraOAuthProxyURL config option

Documentation for: mattermost/mattermost#17888

Updated:
- Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Plugins (Beta)
   - Added the Chimera OAuth Proxy URL configuration setting

* Added ChimeraOAuthProxyUrl to Telemetry

* added note about the setting being available only via config.json

* Update source/configure/configuration-settings.rst

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

* Update source/configure/configuration-settings.rst

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

* Reliable Websockets: default to true (#4918)

Documentation for: mattermost/mattermost#17890

Updated:
- Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings > Experimental Settings only in config.json > Enable Reliable Websockets
    - Updated the default value of the config setting to ``true``

* Added functionality to archive/unarchive teams from system console (#4927)

* Added functionality to archive/unarchive teams from system console

Documentation for: mattermost/mattermost-webapp#8129

Updated:
- Set Up, Manage, Onboard, and Comply > Manage Mattermost > Self-Managed Deployments > Managing Team and Channel Members (E20) > Team Profile
   - Updated section to include details on how to archive/unarchive the team

* Added archive/unarchive updates to Cloud-specific page

* Updated LHS

- Moved self-managed topic from all instances to self-managed
- Added Cloud-specific topic

* added mmctl equivalent for team restore

* added mmctl equivalent for team restore (self-managed)

* Update source/manage/cloud-team-and-channel.rst

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

* Update source/manage/team-channel-members.rst

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

* Update data-retention-policy.rst (#4937)

* Update data-retention-policy.rst

Adding docs for custom data retention policies.

* Update data-retention-policy.rst

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update data-retention-policy.rst

* Update data-retention-policy.rst

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update source/comply/data-retention-policy.rst

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update important-upgrade-notes.rst (#4811)

* Update important-upgrade-notes.rst

* Update important-upgrade-notes.rst

* Update important-upgrade-notes.rst

* Fix typos

* MM-36547 Renamed 'Mute Channel' and 'Edit Channel Header' menus (#4941)

Documentation for: mattermost/mattermost-webapp#8313

Updated:
- Messaging > Manage Teams, Channels, and Members > Managing Channels > Creating a Direct or Group Message
   - Updated section to include mute, unmute, and edit header options for group and direct messages

* MM-35722: CRT, post click open thread (#4942)

Documentation for: mattermost/mattermost-webapp#8342

Updated:
- Messages > Work with Messages > Organizing Conversations using Collapsed Reply Threads (Beta) > Start or Reply to Threads
   - Updated Tip bullet point #1 to clarify that uses can click anywhere in a message in the center pane to view it/reply to it

* MM-35470 Disable config watching logic (#4951)

* MM-35470 Disable config watching logic

Documentation for: mattermost/mattermost#17913

Updated:
- Set Up, Manage, Onboard, and Comply > Set Up Mattermost > Self-Managed Deployments > Configuration Settings
   - Updated introductory content to remove < v5.12 legacy note and add config watcher note and link to mmctl command

* Update source/configure/configuration-settings.rst

Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>

* v5.38.0 Changelog (#4810)

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Apply suggestions from code review

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

* Update self-managed-changelog.md

* Update self-managed-changelog.md

* Update self-managed-changelog.md

Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com>

Co-authored-by: Amy Blais <29708087+amyblais@users.noreply.github.com>
Co-authored-by: Justine Geffen <justinegeffen@users.noreply.github.com>
Co-authored-by: Katie Wiersgalla <39744472+wiersgallak@users.noreply.github.com>
@amyblais amyblais removed the 3: Reviews Complete All reviewers have approved the pull request label Aug 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mkraft mkraft mkraft approved these changes

@cwarnermm cwarnermm cwarnermm approved these changes

Assignees

@wiersgallak wiersgallak

Labels
None yet
Projects
None yet
Milestone
v5.38.0
Development

Successfully merging this pull request may close these issues.
4 participants
@wiersgallak @cwarnermm @mkraft @amyblais