Feature #15875


Introduce 'description' field for sites

Added by Boone Gorges about 2 years ago. Updated almost 2 years ago.

Priority name:
Category name:
Blogs (BuddyPress)
Target version:
Start date:
Due date:
% Done:


Estimated time:
Deployment actions:


In order to power the description field on the sites directory redesign, we need a field where site creators/admins can add a custom description. Here's what I propose:

1. A field during site creation where creators can enter a description (see description-create.png)
2. A similar field will be editable at Dashboard > Settings > General, alongside other metadata fields (see description-edit.png). Available only to Administrators.
3. The textarea will not accept HTML
4. The description shown in the site directory will be truncated to a reasonable length (say, 250 characters), with ellipsis for truncation.
5. Description will be included in cloning.

At the moment, we won't show the description anywhere else, though we could consider it in the future.

I think we don't want to go overboard with tooltips and help text, but it might be worth suggesting to users that there's a maximum recommended length. Or, we could enforce a maximum - this would make sense for the current implementation, but it might be restrictive in the future.


description-create.png (27 KB) description-create.png Boone Gorges, 2022-04-08 10:31 AM
description-edit.png (56.4 KB) description-edit.png Boone Gorges, 2022-04-08 10:31 AM
description-tooltip.jpg (21.1 KB) description-tooltip.jpg Boone Gorges, 2022-04-11 10:55 AM
description-char-count.gif (76.1 KB) description-char-count.gif Boone Gorges, 2022-04-11 10:55 AM

Related issues

Related to CUNY Academic Commons - Design/UX #15261: Directory Design for People, Groups, and SitesResolvedSara Cannon2022-02-03

Actions #1

Updated by Boone Gorges about 2 years ago

  • Related to Design/UX #15261: Directory Design for People, Groups, and Sites added
Actions #2

Updated by Boone Gorges about 2 years ago

A few follow-up items from today's meeting:

- We have decided to limit the character input when creating/editing the description, rather than truncating.
- We discussed the possibility of using the site tagline for a fallback value. It sounds like we're probably not going to do this right away, because taglines may not be very helpful. But we can revisit at some point down the road.

Actions #3

Updated by Boone Gorges about 2 years ago

A first pass at this feature is ready to test on cdev.

A few implementation notes, where I'd welcome feedback or other ideas.

a. The new Description field appears at the top of the list of our custom "metadata" fields, which is to say that it's just above 'Campus'.
b. I added a tooltip to let people know that the information is used in directories. See description-tooltip.jpg.
c. I added a dynamic character counter, to help people understand the character limit. See description-char-count.gif.
d. When cloning a site, the source site's description is prepopulated into the Description field for the new site, but can be changed. This is similar to our other custom metadata fields, such as Campus.
e. The character limit is 200. This allows for a reasonable amount of text, without messing up the directory view too much.

Sara and Colin especially, please let me know if you have requests for changes.

Actions #4

Updated by Colin McDonald about 2 years ago

Thanks Boone, this all looks good to me on an initial CDEV pass. I wonder if the "X (of 200) characters remaining" under the text box could just be "195 of 200 characters remaining" for simplicity, but not much else besides that I noticed right now.

Actions #6

Updated by Boone Gorges almost 2 years ago

  • Status changed from Reporter Feedback to Staged for Production Release
Actions #7

Updated by Boone Gorges almost 2 years ago

  • Status changed from Staged for Production Release to Resolved

Also available in: Atom PDF