Add a Description on to User Groups

[kmeilander]

Prerequisites

• I have added steps to test this contribution in the description below

I also opened a Discussion around this enhancement at #14986 (I wasn't sure if that was needed or not).

Description

On the user groups in the Users section of the backoffice, it would be nice if there was a description field with the group to help user managers know what a user group is for. This is especially useful for custom permission logic, where you are setting logic in the code so it's not apparent based on the settings on the group.

How this works:

On the User Group Edit screen, there is a field for the description under the User Group Name to allow Users to set the description in the same way that Document Type Descriptions are managed.

Once the description is set, it shows on the cards when choosing the group on a user, so the admin user can get more details around what that User Group is for.

Once a Group is Added to a User, it shows the description along with the group details so other Users can see what this Group is for.

[github-actions]

Hi there @kmeilander, thank you for this contribution! 👍

While we wait for one of the Core Collaborators team to have a look at your work, we wanted to let you know about that we have a checklist for some of the things we will consider during review:

• It's clear what problem this is solving, there's a connected issue or a description of what the changes do and how to test them
• The automated tests all pass (see "Checks" tab on this PR)
• The level of security for this contribution is the same or improved
• The level of performance for this contribution is the same or improved
• Avoids creating breaking changes; note that behavioral changes might also be perceived as breaking
• If this is a new feature, Umbraco HQ provided guidance on the implementation beforehand
• 💡 The contribution looks original and the contributor is presumably allowed to share it

Don't worry if you got something wrong. We like to think of a pull request as the start of a conversation, we're happy to provide guidance on improving your contribution.

If you realize that you might want to make some changes then you can do that by adding new commits to the branch you created for this work and pushing new commits. They should then automatically show up as updates to this pull request.

Thanks, from your friendly Umbraco GitHub bot 🤖 🙂

[mikecp]

Hello @kmeilander,

Thanks for this new feature! A member of the core collaborators will have a look at it, but since it's a quite significant change, it might take a little longer than usual for us to go through 😅

Also, it modifies the backoffice UI, and HQ is currently working on the complete refactoring of the backoffice (you might have heard of project bellissima). So, we'll need to check with them if this update still fits in the current version or if it should target V14/bellissima directly.

We'll come back to you with the feedback as soon as possible 😁

[mikecp]

Hello @kmeilander ,

Good news, it's OK for HQ to consider this change for V13 🎉
So we'll be reviewing your PR as it is, no need to target it at V14.

Cheers!

[kmeilander]

@mikecp Great news! I hopping this could make it in to v13.

I did started looking into what it would take to update this for v14. I haven't done much with the new backoffice and so it may take some time to figure out, so that may take some time so good to see that this can get in sooner.

I did notice that most of the checks for this did fail, and i wasn't sure if I should do anything about that. I'm not sure why the builds didn't run (looks like a connection issue).

I also reviewed the CodeScene Analysis and while I understand the comments, I followed the standard already in place for the file and so I'm not sure what the recommended solve is for some of that stuff (like having fewer arguments in a constructor). If there guidance around fixing those items let me know and I can get that updated.

[umbrabot]

Hi there @kmeilander!

First of all: A big #H5YR for making an Umbraco related contribution during Hacktoberfest! We are very thankful for the huge amount of PRs submitted, and all the amazing work you've been doing 🥇

Due to the amazing work you and others in the community have been doing, we've had a bit of a hard time keeping up. 😅 While all of the PRs for Hacktoberfest might not have been merged yet, you still qualify for receiving some Umbraco swag, congratulations! 🎉

In the spirit of Hacktoberfest we've prepared some exclusive Umbraco swag for all our contributors - including you!

As an alternative choice this year, you can opt-out of receiving anything and ask us to help improve the planet instead by planting a tree on your behalf. 🌳

Receive your swag or plant a tree! 👈 Please follow this link to fill out and submit the form, before December 15th, 2022, 23:59:00 UTC.

Following this date we'll be sending out all the swag, but please note that it might not reach your doorstep for a few months, so please bear with us and be patient 🙏

📢 We have just published a summary of all the activity throughout this year's Umbraco Hacktoberfest.

The only thing left to say is thank you so much for participating in Hacktoberfest! We really appreciate the help!

Kind regards,
The various Umbraco teams.

[georgebid]

Hey @kmeilander! I have had a look at your PR, and fixed the merge conflict (I think). I have attempted to run your code locally but I am getting this error as soon as I hit the back office:

I have built the FE/BE and attempted to run it - are there some steps I could be missing? Or would you like to double-check my merge conflict fix to see if that's causing this issue?

Let me know if you have any ideas and I will take another look!

CC: @mikecp in case you have any thoughts 😛

[kmeilander]

@georgebid it looks like my DB migration wasn't running since it was still targeting v13 (and the merge added it above some of the other 13 DB migrations). I'm assuming this would be for 13.1 so i updated the migration namespace to reflect that and made sure it was added to the end of the DB script list.

See if it works for you now. It was originally working for me on a new install, but now it should also work if you are migrating from an older version.

[georgebid]

Ah, great, thank you @kmeilander - I will take a second look at this soon 😄

[nul800sebastiaan]

Hi there @kmeilander and thanks for the work on this one.

As you may or may not know, we're working on a rewrite of the Umbraco backoffice, codenamed Bellissima (https://umbraco.com/blog/bellissima-preview-releases-of-the-new-backoffice/) and we're trying to make sure that it has feature parity with the current AngularJS-based backoffice.

We're at a point in the development phase where we want to start wrapping up a beta version to ship some time "soon" and we're going to have to implement a feature freeze on the current backoffice so that we don't keep increasing the scope of Bellissima. Unfortunately that means we're going to have to stop accepting PRs like this one that create significant changes to the current backoffice.

As a general rule from now on, we're still happy for features in C# code but anything that gets introduced or refactored in AngularJS probably won't make it. Bugfixes are still great of course!

Thanks for the efforts here and we hope to see you back as a contributor soon! 👍