Project

General

Profile

Feature #15220

Extending the OER Metadata Tag

Added by Laurie Hurson 4 months ago. Updated 5 days ago.

Status:
Testing Required
Priority name:
Normal
Assignee:
Category name:
Groups (misc)
Target version:
Start date:
2022-01-25
Due date:
% Done:

0%

Estimated time:

Description

I noticed the OER Metadata tag is only available on sites with the teaching purpose.

Maybe this was our original intent and scope? But I think it would be beneficial to make this tag available on any site.

A use case: there are a group of grad students developing an OER site that hosts resources for teaching music . The purpose is listed as "community of interest" but the site does host OER and therefore, it would be helpful if the site could be tagged as containing oer. This would also mean we would need to extend the tag search/filter to the site directory.

I think this above use case could apply to various other OER sites that offer OER but are not courses.

Adding this ticket to flag this as a possible new feature / extension of the existing feature.

Screen Shot 2022-01-27 at 1.04.50 PM.png (88.3 KB) Screen Shot 2022-01-27 at 1.04.50 PM.png Laurie Hurson, 2022-01-27 01:06 PM
Screen Shot 2022-01-27 at 1.04.38 PM.png (124 KB) Screen Shot 2022-01-27 at 1.04.38 PM.png Laurie Hurson, 2022-01-27 01:06 PM
Screen Shot 2022-01-27 at 1.05.24 PM.png (188 KB) Screen Shot 2022-01-27 at 1.05.24 PM.png Laurie Hurson, 2022-01-27 01:06 PM
Screen Shot 2022-01-27 at 1.05.35 PM.png (238 KB) Screen Shot 2022-01-27 at 1.05.35 PM.png Laurie Hurson, 2022-01-27 01:06 PM
tooltip.png (42.5 KB) tooltip.png Boone Gorges, 2022-04-11 05:15 PM
dashboard.png (26.7 KB) dashboard.png Boone Gorges, 2022-04-11 05:17 PM
directory-notice.png (73.8 KB) directory-notice.png Boone Gorges, 2022-04-11 05:27 PM
Peek 2022-04-19 14-57.gif (173 KB) Peek 2022-04-19 14-57.gif Boone Gorges, 2022-04-19 04:03 PM
Peek 2022-04-19 14-59.gif (44.2 KB) Peek 2022-04-19 14-59.gif Boone Gorges, 2022-04-19 04:03 PM
Screenshot_2022-04-25_15-26-58.png (21.9 KB) Screenshot_2022-04-25_15-26-58.png Boone Gorges, 2022-04-25 04:28 PM
general-header.png (32.8 KB) general-header.png Boone Gorges, 2022-04-26 11:04 AM
bare-checkbox.png (19.1 KB) bare-checkbox.png Boone Gorges, 2022-04-26 11:04 AM
Create group - OER tag.png (91.2 KB) Create group - OER tag.png Laurie Hurson, 2022-05-10 10:16 AM
Create site - oer tag.png (92.8 KB) Create site - oer tag.png Laurie Hurson, 2022-05-10 10:16 AM
Group Manage - OER tag.png (103 KB) Group Manage - OER tag.png Laurie Hurson, 2022-05-10 10:16 AM
Site dashboard - oer tag.png (64.7 KB) Site dashboard - oer tag.png Laurie Hurson, 2022-05-10 10:16 AM
group-manage.png (26.3 KB) group-manage.png Boone Gorges, 2022-05-13 12:01 PM
group-create.png (26.1 KB) group-create.png Boone Gorges, 2022-05-13 12:01 PM
site-create.png (33.5 KB) site-create.png Boone Gorges, 2022-05-13 12:01 PM

History

#1 Updated by Laurie Hurson 4 months ago

  • Description updated (diff)

#2 Updated by Matt Gold 4 months ago

that sounds reasonable to me

#3 Updated by Colin McDonald 4 months ago

Sounds ok to me too, if we think (maybe using documentation to be sure) that it won't result in confusion about what the OER tag means, either in the directory filter or when asking people to select it.

I wasn't sure about this part, though. Isn't the OER tag filter available on directories for Sites, Courses, and Groups already? "This would also mean we would need to extend the tag search/filter to the site directory."

#4 Updated by Laurie Hurson 4 months ago

I think a tool tip in the Setting area and creation portal and documentation added to the HELP section could help clarify the use of this tag.

And currently, I do see that you can search the tag in the site and group directories but I do not see the ability to tag as OER unless the site is categorized as teaching purpose (screenshots)

#5 Updated by Boone Gorges 4 months ago

Laurie is correct that the OER checkbox is only available for Teaching groups/sites. I looked back at the original ticket but I couldn't find a place where we explicitly discussed this. I must just have assumed it would be the case when I worked up my initial mockups. https://redmine.gc.cuny.edu/issues/14170#note-10

There's no technical reason why it has to work this way. The checkbox could be moved so that it appears regardless of Primary Purpose. I guess it's just a question of whether we want it to appear everywhere.

#6 Updated by Colin McDonald 4 months ago

I follow the reasoning for showing the checkbox everywhere. We could move ahead with it, or potentially see if there's time to raise this with the group during next week's meeting if we'd like.

#7 Updated by Matt Gold 4 months ago

Is there any reason not to show it?

#8 Updated by Boone Gorges 4 months ago

Is there any reason not to show it?

Just a general desire not to add more things to the interface. The OER checkbox will not be relevant for most groups/sites on the Commons, and for many users the meaning of the checkbox will be opaque. Moreover, if/when we introduce more types of miscellaneous "tags" for groups/sites, do we just want to tack another checkbox onto the bottom of the form?

We generally try to simplify and take away, so we should be thoughtful when adding new things.

#9 Updated by Matt Gold 4 months ago

Good points!

#10 Updated by Colin McDonald 3 months ago

Just updating from our team meeting on Friday that we discussed implementing an OER checkbox for Groups and Sites in the creation flow and for current instances when we can, to start populating those results before displaying them. It should also help us determine HOW to display everything, as we see what's being created and tagged with OER.

We'll want to do some outreach and documentation, especially to get current admins to go back and add the OER tag. I'll defer to Laurie on ideas/planning for this, but I'm happy to help.

I'm not sure if an intermediate release or spring release makes sense for this. We might as well start collecting the info as soon as we can, but we need to have our process in place for explaining and promoting the new tag.

#11 Updated by Laurie Hurson 3 months ago

Hi All,

I can get started on writing up a documentation help pages on the OER tag. I will add to this page : https://help.commons.gc.cuny.edu/using-oer/

I can also plan to make another page specifically dedicated to the tag. However, I want to work with the OER working group to clarify how the tag will work before I finalize the documentation.

Thoughts on the release and outreach: Perhaps once we clarify the tag application/functionality/display we could do a "soft release" where I reach out to OER reps on each campus to let them know the tag is available and explain its application. I could ask that they tag relevant content to begin to populating the tag. Then we could do a more public release with the spring release to alert all users to the tag and its application. What do we think about that?

#12 Updated by Matt Gold 3 months ago

Great idea, Laurie!

#13 Updated by Laurie Hurson 2 months ago

Hi All,

A group of us met on march 1st to discuss the OER Tag. Some updates:

TAG FUNCTION
- Everyone agrees on expanding the tag to all sites and groups

- OER meta data can be collected during group/site creation, but also located in the backend of sites (settings) and groups (manage)

-For now it will remain a generalized, somewhat "fuzzy" tag for inital data collection and possible organization w/in the tag later.

- We plan to choose broadest language - "This site uses or contains open educational resources" or “This site/group uses, compiles, or is an Open Educational Resource” -- feedback on this language welcome!

TAG APPLICATION
- Tag will be applied by users to their own sites/groups but it will also require occasional monitoring to make sure people are not misusing this tag and misunderstanding "oer" for example someone thinking just because the site is public it is oer

- An open question about tag application: What do we do about blended materials - if not everything on the site is open? I think this can be mediated by the language for tag application "uses, compiles, or is" - but do we want to consider adding a warning somewhere like "not all content on all sites and groups tagged oer is open, please look for open licenses" or something?

TAG DOCUMENTATION
- We will want to create a tool tip at oer checkbox location with brief overview and link to more extensive HELP documentation, which I plan to write this week or next. I will update here when it is ready for feedback.

- We can also link to this HELP documentation to/from the OER showcase page to show off what is already tagged as an oer on the Commons.

Colin, or anyone else in the meeting, feel free to add anything I may have forgotten. thanks!

#14 Updated by Boone Gorges 2 months ago

Cool, glad to hear we're moving forward.

Colin, as the team comes to a consensus about functionality, could you please have a look at the existing functionality and let me know what needs changing from a technical point of view? Is it merely turning on the toggle for all group types, during creation and edit?

#15 Updated by Laurie Hurson 2 months ago

Hi all,just trying to help move this forward...

look at the existing functionality and let me know what needs changing from a technical point of view?

Currently the OER checkbox appears in two places
- During site creation if the user selects the "teaching" purpose
- In the site dashboard if teaching was previously selected or if the user changes the site to the teaching purpose

In this update the OER checkbox (language TBD) should appear:
- During site creation below purpose drop down (therefore OER checkbox would be visible all of the time, for all purposes)
- During group creation, below purpose
- In the site dashboard General>settings
- In the group Manage>Details

Is it merely turning on the toggle for all group types, during creation and edit?

yes, i think so, and adding it to the settings/manage areas for all groups and sites.

#16 Updated by Boone Gorges 2 months ago

  • Category name set to Groups (misc)
  • Assignee set to Boone Gorges
  • Target version set to 2.0.0

Thanks, Laurie. This is helpful. So I have to (a) move the checkbox interface so that it's no longer listed under the Teaching-only fields, and then (b) make sure it's enabled for all groups.

#17 Updated by Laurie Hurson 2 months ago

Hi Boone,

(a) move the checkbox interface so that it's no longer listed under the Teaching-only fields

yes, separating the "oer" tag from the purpose field designation

(b) make sure it is enabled for all groups.

yes

And, I would add: make sure the oer tag checkbox is editable in the back end of all sites and groups, regardless of purpose metadata.

#18 Updated by Boone Gorges 2 months ago

Yes, from a technical point of view, the changes made for creation will apply automatically for editing. But it's good to be explicit :-D

#19 Updated by Colin McDonald 2 months ago

Thanks for jumping on the clarifications, Laurie! The only remaining to-do that I see here is finding the best way to feature/integrate the documentation when it's ready, so people are as aware of it as possible when deciding whether to apply the tag.

Regarding this from an earlier update...

- An open question about tag application: What do we do about blended materials - if not everything on the site is open? I think this can be mediated by the language for tag application "uses, compiles, or is" - but do we want to consider adding a warning somewhere like "not all content on all sites and groups tagged oer is open, please look for open licenses" or something?

...It seems to me that the tag application language does make it clear that the tag is ok with blending. But on the warning part in the second question, are you talking more about a warning that would appear on the directory side, when people filter using the OER tag? I could see that being useful, and right now we do have some room in that Tags dropdown because OER is the only tag.

#20 Updated by Laurie Hurson 2 months ago

- An open question about tag application: What do we do about blended materials - if not everything on the site is open? I think this can be mediated by the language for tag application "uses, compiles, or is" - but do we want to consider adding a warning somewhere like "not all content on all sites and groups tagged oer is open, please look for open licenses" or something?

Can we add a tool tip that has some kind of clarification with the language Colin suggested, "Not all content on all sites and groups tagged OER is open, please look for open licenses to determine which content is openly licensed. To learn more see our documentation on XYZ" and link to documentation about the OER tag? Can we use links in tool tips? Not sure I have seen this before.

...It seems to me that the tag application language does make it clear that the tag is ok with blending. But on the warning part in the second question, are you talking more about a warning that would appear on the directory side, when people filter using the OER tag? I could see that being useful, and right now we do have some room in that Tags dropdown because OER is the only tag.

Not sure if this info would make sense within the drip down box but maybe, in addition to the tool tip above which would appear during site/group creation or settings, if you filter by OER in a directory search, a box appears at the top of the search results with this clarification? Not sure if that is technically possible.

Working on the documentation in this google doc: https://docs.google.com/document/d/1XVhgj2PqeN7retm40UCzjlpEpqX36sVZKwKs_Rcm2Z8/edit?usp=sharing

I have identified the HELP and other pages that likely need to be updated to include new info about the tag. I will work on some new language and we can refine in the doc and updates the pages when the tag updates go live. Does this sound like a reasonable workflow for updating this documentation?

#21 Updated by Colin McDonald about 2 months ago

Adding a couple of watchers here, and perhaps we can touch on a couple of the technical questions in the meeting(s) today.

#22 Updated by Laurie Hurson about 1 month ago

Following up on this after Friday's call to finalize and address a few outstanding questions

OER Tag Language: This site/group uses, compiles, or is an open educational resource.

OER Tag Clarification language: "Please be aware: not all content on sites and groups tagged as OER is openly licensed. Please look for open licenses to determine which content can be shared, reused, and remixed. To learn more about open content and this OER tag, please see our documentation on OER.”

1. Can this clarification language appear:
-- 1. in a tool tip in the creation process,
-- 2. as a part of the message in the group/site backend. It would come after the line "If checked, Commons users will be able to discover your site in directories by using the Open Educational Resources filter."
-- 3. At the top of the search results if you have searched using the filter? Maybe it ony needs to appear once and the suer can "dismiss".

#23 Updated by Boone Gorges about 1 month ago

-- 1. in a tool tip in the creation process,
-- 2. as a part of the message in the group/site backend. It would come after the line "If checked, Commons users will be able to discover your site in directories by using the Open Educational Resources filter."

Could I get some clarification on how these things differ? I've attached an image tooltip.png that shows the existing OER selector during group creation. I've also attached an image dashboard.png showing what the interface looks like at Dashboard > Settings > General. I assume we made them different because the WP Dashboard doesn't conventionally have tooltips, but instead uses the grey "description" paragraph. So my interpretation here is:

a. During group and site creation, keep the current tooltip, but change it so that the text says "Please be aware: ..." after the current text. This will make the tooltip very long.
b. At Dashboard > Settings > General, keep the existing text, and add another sentence (or another line?) 'Please be aware: ..."

As things currently stand, it's not possible to put links in a tooltip, but it's likely we could make a change to allow it. (Dev team - we'll swap the esc_html() with some kind of kses function.) We'll need to ensure there's some sort of minimal text styling, and also make sure that hovering and clicking doesn't have any weird conflicts with the behavior of the tooltips.

-- 3. At the top of the search results if you have searched using the filter? Maybe it ony needs to appear once and the suer can "dismiss".

We don't currently have any convention for showing notices on directories. I would want some guidance from Sara on how and where it should appear. directory-notice.png is my 3-minute attempt to add something noticeable but not too obtrusive.

#24 Updated by Laurie Hurson about 1 month ago

Hi Boone,

Clarifying the language below...

a. During Creation (tool tip): "This site/group will use, compile, or function as an open educational resource. If checked, Commons users will be able to discover your site/group in directories using the Open Educational Resources filter."

b. Site/group back end (gray description): "This site/group uses, compiles, or is an open educational resource. If checked, Commons users can discover your site/group in directories by using the Open Educational Resources filter. To learn more about open content and this OER tag, please see our documentation on OER [link]."

c. Notice in site/groups directories if OER tag is searched: "Please be aware: not all content on sites and groups tagged as OER is openly licensed. Please look for open licenses to determine which content can be shared, reused, and remixed. To learn more about open content and this OER tag, please see our documentation on OER [link].”

Not sure if this is refined or use-specific enough -- I am open to feedback.

Thanks!

#25 Updated by Boone Gorges about 1 month ago

Thanks, Laurie. I think this is much clearer.

I'll wait for some initial feedback from Sara on design for the proposed directory notice before working on implementation.

#26 Updated by Sara Cannon about 1 month ago

@boone I think that Dircetory notice design is great! Maybe just un-italicize and make it the same size font as the filters?

#27 Updated by Boone Gorges about 1 month ago

Thanks, Sara!

I've made a first pass at implementing this. One small interface oddity is that, by moving the OER checkbox just under Purpose, we have to decide what to do when you select 'Teaching' and new fields are added to the field. I've opted to keep the OER checkbox pinned to the bottom of the form, even when selecting Teaching. This ensures that the fields that are linked to the Purpose dropdown appear immediately after the Purpose dropdown. I've attached a few gifs that are probably clearer than this explanation. IMO this is a bit less jarring than keeping OER directly under Purpose, but it can be easily changed if others disagree.

We can't close this ticket until Laurie provides me with the documentation URL so that I can add the necessary link to the helper text.

#28 Updated by Laurie Hurson 29 days ago

Hi All,

I am still pulling together the screenshots but the OER Tag Help page that we can link to will be here:

https://help.commons.gc.cuny.edu/oer-tag-for-groups-sites/

I watched the GIFs and I agree with leaving the check box at the bottom.

However, can we give this field during the creation phase ( Peek 2022-04-19 14-59.gif) a title -- perhaps "Open Educational Resources" -- to distinguish it from "Disciplinary cluster" which it is below currently? It appears to have a title in the site dashboard already. (Peek 2022-04-19 14-57.gif)

#29 Updated by Boone Gorges 28 days ago

The structure is different in the site dashboard because of the way that settings are laid out there.

We can add something for the BP side of things, but what would it look like? See attachment for one possibility, though there's some redundancy there. (I don't think we should just have a header with nothing but a checkbox underneath.)

#30 Updated by Laurie Hurson 28 days ago

I am not opposed to header and checkbox, especially since other fields just have a header and the content selection. But if others agree this doesn't make sense we can nix the header.

#31 Updated by Boone Gorges 28 days ago

The bare checkbox seems like pretty bad UX to me. I find it hard to understand what the checkbox is related to. See bare-checkbox.jpg.

We could also consider a generic header like 'Additional Information'. See general-header.png.

#32 Updated by Laurie Hurson 28 days ago

I agree. I dont think a bare checkbox is a good idea.

In the first image you sent (Screenshot_2022-04-25_15-26-58.png) it had "Open Educational Resources" as the header and the checkbox had the information next to it, "This site/group will use, compile, or function as an open educational resource".

I think "Open Educational Resources" header text or "Additional Site (or group) information" as header text would be fine. My goal is to use a header to differentiate and call out this area.

#33 Updated by Colin McDonald 28 days ago

What if we just include the entire "tool tip" text right next to the checkbox? "This site/group will use, compile, or function as an open educational resource. If checked, Commons users will be able to discover your site/group in directories using the Open Educational Resources filter."

Then there's no redundancy, no extra step for the user to know/accept the terms, etc.

#34 Updated by Colin McDonald 28 days ago

I should clarify that this is if we go ahead with Open Educational Resources already as the header.

#35 Updated by Boone Gorges 28 days ago

Colin, I'd had a similar idea, but I was concerned that this strategy goes against our broader goals of taking text off the screen and moving it into tooltips.

#36 Updated by Laurie Hurson 21 days ago

Circling back to the discussion about header and text for OER tag during site/group creation:

Header: Additional [Site/Group] Information

Checkbox: [] "This site/group will use, compile, or function as an open educational resource.

tool tip text: "If checked, Commons users will be able to discover your site/group in directories using the Open Educational Resources filter."

Does this work?

#37 Updated by Laurie Hurson 14 days ago

Hi All,

Circling back to this. I was on the dev site and noticed the language has not been updated so I am providing an outline with screenshots for how the text should read in each location below:

Create Group or Create site
Header: Additional Information
[checkbox] This [site or group - depending on location] will use, compile, or function as an open educational resource.
Tool Tip: "If checked, Commons users will be able to discover your site or group in search directories using the Open Educational Resources filter."

Site Dashboard
Header: Additional Site Information
checkbox] This site uses, compiles, or functions as an open educational resource. (this is different from current text on dev)
Gray description text: "If checked, Commons users can discover your site in directories using the Open Educational Resources filter. To learn more about open content and this oer tag, please see our documentation on OER (https://help.commons.gc.cuny.edu/oer-tag-for-groups-sites/)

Group Manage
Header: Additional Group Information
checkbox] This group uses, compiles, or functions as an open educational resource. (this is different from current text on dev)
Tool Tip: "If checked, Commons users can discover your site in directories using the Open Educational Resources filter. To learn more about open content and this oer tag, please see our documentation on OER (https://help.commons.gc.cuny.edu/oer-tag-for-groups-sites/)

Thanks!

#38 Updated by Boone Gorges 14 days ago

Thanks for laying this out, Laurie. I've implemented it as you've specified in https://github.com/cuny-academic-commons/cac/commit/a675f9f88b37ee3a94b20e9409ac1b4845d7dfa7 and it's ready to test on cdev.

A couple notes about it:

- I had to introduce distinctions between "create" and "edit" language ("this group will use" vs "this group uses", etc) that didn't previously exist
- When creating a group or site, there's no documentation URL in the tooltip. When editing a group, there is a documentation URL in the tooltip.
- To support URLs in tooltips, I had to make some styling changes (for visibility, and also to ensure that it was possible to move the mouse from the question-mark to the tooltip without it disappearing)
- Laurie's "create" tooltip has the phrase "search directories" while the group/site edit text does not.

Have a look and let me know if you'd like changes.

#39 Updated by Colin McDonald 13 days ago

Two quick testing notes from me:

- I can't seem to find an OER checkbox/text for the Site part of the Group + Site creation flow. I thought maybe we were carrying it over automatically from when you check it first for the Group, but the created site right now isn't checked OER when checking in the admin settings.

- When cloning an OER-checked site, the OER checkbox isn't automatically checked/populated for the clone like it is for the campus and purpose. Shouldn't it be?

#40 Updated by Boone Gorges 12 days ago

  • Status changed from Reporter Feedback to Testing Required

- I can't seem to find an OER checkbox/text for the Site part of the Group + Site creation flow. I thought maybe we were carrying it over automatically from when you check it first for the Group, but the created site right now isn't checked OER when checking in the admin settings.

Fixed in https://github.com/cuny-academic-commons/cac/commit/2d0ff167b97766a8c390bb270f45837ce9dc1cef. The checkbox is now present on the Add Site tab, and is pre-checked (or not) depending on the group status from the first creation step.

- When cloning an OER-checked site, the OER checkbox isn't automatically checked/populated for the clone like it is for the campus and purpose. Shouldn't it be?

Fixed for site cloning in https://github.com/cuny-academic-commons/cac/commit/e587e5259cc0a487a6f77295cf3fe76558f1c9f2 and group cloning in https://github.com/cuny-academic-commons/cac/commit/08ec099cb4e7da9c2ab9f771314f35353846d4f2

#41 Updated by Laurie Hurson 11 days ago

- I had to introduce distinctions between "create" and "edit" language ("this group will use" vs "this group uses", etc) that didn't previously exist

Thanks this seems fine.

- When creating a group or site, there's no documentation URL in the tooltip. When editing a group, there is a documentation URL in the tooltip.

I think we dont need to link to documentation during creation because we dont want to interrupt the creation flow? I figured if you were editing your group, you are more likely to click into documentation since your editing demonstrates interest in better defining, building out your group... I am open to changing any of this.

- To support URLs in tooltips, I had to make some styling changes (for visibility, and also to ensure that it was possible to move the mouse from the question-mark to the tooltip without it disappearing)

This looks good thank you

- Laurie's "create" tooltip has the phrase "search directories" while the group/site edit text does not.

Let change text in group/site edit to "search directories"

More edits:
- the header "additional group information" needs padding and to be bold in group>manage area, and all creation flows (group, site, group/site)

#42 Updated by Boone Gorges 11 days ago

In https://github.com/cuny-academic-commons/cac/commit/ae46c31ce5e691905cee6469d2d3915a19e431b8 I added 'search directories' where necessary.

- the header "additional group information" needs padding and to be bold in group>manage area, and all creation flows (group, site, group/site)

It should already be properly formatted. See attached screenshots. If you're seeing something different, try a hard-refresh/cache clear. If you're seeing what I'm seeing but want it to look different, please provide details.

#43 Updated by Colin McDonald 7 days ago

I went back to the cloning and Group+Site issues that I flagged, and the tests look good now. Laurie, when the last points here seem ready from your side, I think that we can close this up.

#44 Updated by Laurie Hurson 6 days ago

Apologies for this last minute request/add...

Would it possible to set up a process where i get an email every time someone assigns this tag. The email would contain:

- when tag was assign
- group / site link
- admin name of person who assigned tag

If this is not possible or is a lot of list, please just let me know.

However I think moving forward this would be important info for me to have. We got a question from a librarian that raised concerns about users being able to tag their own content as OER...which we may have talked through in the past. I think a notification where i can check out what's being tagged would be really helpful here.

#45 Updated by Boone Gorges 5 days ago

Also available in: Atom PDF