docs icon indicating copy to clipboard operation
docs copied to clipboard

Help Wanted: Document Mattermost user administration workflows

Open cwarnermm opened this issue 3 years ago • 5 comments

Problem space The Mattermost Product Documentation doesn't offer comprehensive information for system administrators on how to manage users in the System Console via https://docs.mattermost.com/configure/user-management-configuration-settings.html.

Target audience System administrators

Goal Develop and publish comprehensive documentation on how system administrators can manage users via the System Console that describes:

  • how to active/deactivate users
  • how to manage a user's roles
  • how to manage a user's teams
  • how to reset a user's password
  • how to update a user's email
  • how to revoke a user's sessions
  • how to search for a user to manage
  • how to review a user's profile details and authentication method
  • how to filter user search to narrow down results using the team and user status filters

Delivery expectations

  • 1 PR with all proposed changes
  • Use existing system admin documentation content as a guideline towards voice and tone
  • Comment in the PR to request a generated preview of your work. The Docs team will add the appropriate labels to your PR.

Tech needed

  • Sphinx
  • Mattermost system administration
  • RST format

Affected repository mattermost/docs

Where to get help Join the Mattermost Docs team on the Mattermost Community Server in the ~Documentation Working Group channel to discuss this ticket, or feel free to comment in this docs ticket

cwarnermm avatar Oct 07 '22 18:10 cwarnermm

Please assign me to this

Valliammai-SM avatar Oct 07 '22 19:10 Valliammai-SM

Thank you, @Valliammai-SM, for helping us with this important documentation update for system administrators!

cwarnermm avatar Oct 07 '22 19:10 cwarnermm

I want to try Can you assign this to me?

ayrotideysarkar avatar Nov 22 '22 16:11 ayrotideysarkar

@ayrotideysarkar - Are you actively working on this ticket?

cwarnermm avatar Jan 18 '23 14:01 cwarnermm

Yup... Sorry @cwarnermm my grandma's health was not well, so was busy with stuffs.. I will work on this ticket and sorry for the delay 🙂

ayrotideysarkar avatar Jan 18 '23 15:01 ayrotideysarkar

@cwarnermm I would love to take this up. Feel free to assign this to me. Also, do let me know if this will be a completely new page titled Manage Users under the Use Mattermost > Connect and Collaborate section or will these details be added to some existing page. Thanks.

Rutam21 avatar Apr 21 '24 17:04 Rutam21

Looking forward to working with you on this, @Rutam21! Thank you! These details will be added to the administrator section of the Mattermost Product Documentation via https://docs.mattermost.com/configure/user-management-configuration-settings.html.

cwarnermm avatar Apr 22 '24 13:04 cwarnermm