Skip to content

User management docs #137

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

Merged
merged 26 commits into from
Feb 8, 2024
Merged

User management docs #137

merged 26 commits into from
Feb 8, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Oct 10, 2023

Internal Notes for Reviewers

This PR adds a new user management section to our user guide that includes:

  • Initial overview and user task placeholders from @nrichers
  • User task updates from @subatraSR2 that are in scope based on the code updated done by ServiceRocket (see "What's in scope?")

Output

A preview is available: https://docs-demo.vm.validmind.ai/guide/user-management.html

URLs Screenshot
User management
   Manage users
   Manage groups
   Manage roles & permissions
image

What's in scope?

PRs created by ServiceRocket that relate to user management: https://github.com/validmind/frontend/pulls?q=is%3Apr+label%3Aservicerocket+

image

References

These docs are likely incomplete and need need to be tested and revised further as the functionality gets implemented. The intent here is to seed our user guide with some placeholder content that Service Rocket can build on.

Addresses https://app.shortcut.com/validmind/story/2136/create-user-guide-placeholders-for-user-management.

External Release Notes

Our user guide now includes end-to-end instructions for managing users on the ValidMind platform. This new content covers common tasks such as inviting new users, adding them to user groups, and managing roles and permissions. Learn more ...

@nrichers nrichers added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Oct 10, 2023
@CLAassistant
Copy link

CLAassistant commented Oct 10, 2023

CLA assistant check
All committers have signed the CLA.

@subatraSR2 subatraSR2 force-pushed the user-management-placeholders branch from f6a5aaa to 57428b6 Compare January 6, 2024 00:52
@subatraSR2
Copy link
Contributor

@nrichers this is ready for your review
image

Copy link
Collaborator Author

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

@subatraSR2 thank you for your updates! I made some suggested edits you can commit directly with Commit suggestion and left a few other comments as well. Let me know if you have any questions.

subatraSR2 and others added 13 commits January 29, 2024 22:16
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Made changes to change bullet list to alphebetically ordered list
@subatraSR2
Copy link
Contributor

Thanks to @nrichers, we have just done a full render of the docs site with reference to pull requests concluded by ServiceRocket.

@nrichers nrichers changed the title User management placeholders User management docs Feb 2, 2024
@nrichers nrichers added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Feb 2, 2024
@nrichers nrichers requested a review from cachafla February 2, 2024 02:59
@nrichers nrichers requested a review from mehdi0501 February 2, 2024 02:59
@nrichers
Copy link
Collaborator Author

nrichers commented Feb 6, 2024

@cachafla and @mehdi0501 if you have a chance, could you take a look at this pull request, please?

@nrichers nrichers added documentation Improvements or additions to documentation and removed internal Not to be externalized in the release notes labels Feb 7, 2024
Copy link
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

Excellent 👏

@nrichers
Copy link
Collaborator Author

nrichers commented Feb 8, 2024

@mehdi0501 #137 (comment) is another comment I can't reply to directly, but I have made the suggested change verbatim.

nrichers and others added 6 commits February 7, 2024 17:11
Co-authored-by: Andres Rodriguez <andresr83@gmail.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
Co-authored-by: mehdi0501 <98982652+mehdi0501@users.noreply.github.com>
…ocumentation into user-management-placeholders
@nrichers nrichers merged commit c52f6e7 into main Feb 8, 2024
@nrichers nrichers deleted the user-management-placeholders branch February 8, 2024 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants