1007351 - Create a new "editorial title" field for published makes and teaching kits

Status: RESOLVED WONTFIX

(Webmaker Graveyard :: Design & UX, defect)

Description

[Matt Thompson (@OpenMatt :OpenMatt)]

* We need an easy way to give featured teaching kits a clearer, more descriptive title. So that community-generated kits in the "featured teaching resources" section of the textbook appear with clearer titles.

* Let's create a new editable field in the Make API that admins can edit and update. 

* This is a better alternative than what we're currently doing -- using the MakeAPI to overwrite user's titles.

Comment 1

[Kat Braybrooke [:codekat]]

Hey Cassie and Kate, 

Just bringing this up again after our conversation at the Sprint as we release the first competency page. We'd really like those teaching kits to be more descriptive, so people know why we've chosen them. 

Happy to discuss the details of this further where needed.

Comment 2

[Kat Braybrooke [:codekat]]

For clarity, we actually need the functionality to edit *all 3* parts of the kit/activity.

So, an editable field for: 

1) Title of the make. 
2) Author name of the make. 
3) Description of the make.

At the moment, we can edit title and description of make in the MakeAPI, but not author name (ie, adding last name and affiliation). And not sure whether MakeAPI is the way you want us to do this.

Comment 3

[inactivate account for kate]

Do you guys mean for *all* kits or only for the ones that are featured on /resource pages?

Comment 4

[Kat Braybrooke [:codekat]]

Kate, 

If it could be for all kits, that would be great as it would allow us that functionality for various things in the future. For example, I'd like it for starter resources we put on the new /gallery page, too.

Thanks!

Comment 5

[inactivate account for kate]

This needs to be discussed with cade then, since it would require a makeapi schema change. Reassigning!

Comment 6

[inactivate account for kate]

What do you think about these proposed changes?

Comment 7

[Chris DeCairos (:cade)]

We can easily add editorial fields. Do they need to be searchable?

Comment 8

[Kat Braybrooke [:codekat]]

Hey Cade - It would be nice if they could be, although not entirely sure how this would work differently from them being *not* searchable...

Comment 9

[Cassie McDaniel [:cassiemc]]

Yes they should be searchable. For instance, if a user sees a title and description in the resources section, and searches for that title or keyword on webmaker.org, that make should be findable.

Comment 10

[Matt Thompson (@OpenMatt :OpenMatt)]

@ Chris: does this make sense? Can we implement? 

* Please move to [June27] if not in scope for this week

Comment 11

[Chris DeCairos (:cade)]

I don't think that this is a good way to solve our problem.

It will cause unnecessary complexities in our search logic around titles, descriptions and author fields.

Comment 12

[Jon Buckley [:jbuck]]

If we overwrite these fields, where do the original fields get shown? If they only get shown in each apps editor... then why have them? If I, as a user, can't modify my own title/descriptions/author name that show up on webmaker.org, then why even have separate fields? You'd be better off just overwriting the existing title/description/author.

Comment 13

[Kat Braybrooke [:codekat]]

The main point here is that we need to add *additional* information on top of what's already provided for the resources in "Teach" section. 

Perhaps another option is to leave things as the authors created them in the MakeAPI, but add the additional "editorial description" field to go underneath each resource with our context added. 

For example, under "Infrastructure", there is currently one resource in the "teach" section which doesn't have much information provided: https://webmaker.mofostaging.net/resources/literacy/weblit-Infrastructure

What we'd want here is to add *another additional field*, a sentence or two long, that provides editorial notes, ie "This activity was made for the Lo-Fi, No-Fi Teaching Kit in San Francisco." (etc.)

Does that change things somewhat? Might be less intrusive than overwriting author data...

Comment 14

[Brett Gaylor [:brett]]

yeah we dont want to overwrite author data.  We want to be able to allow them to call the make what they want, but for us to have an editorial mechanism to make descriptive titles

Comment 15

[Matt Thompson (@OpenMatt :OpenMatt)]

* Are we clear on this now? Can we implement? This is needed for [june13] release

Comment 16

[Chris DeCairos (:cade)]

Perhaps we do need an editorial mechanism, but I don't believe it belongs as a part of the MakeAPI.

A small proportion of all makes will ever make use of editorial fields, so adding the them to the entire database doesn't feel optimal. Perhaps this is something that the Make List API can handle?

Comment 17

[Jon Buckley [:jbuck]]

It sounds like we have two separate feature requests here:

1) Modifying the author, description, and title for the featured teaching resources on /resources
2) Modifying the author, description, and title for makes on /gallery, /privacy-makes, /search, /teach, /me, and /details

#1 can solved by editing the JSON files on https://github.com/mozilla/webmaker.org/blob/master/public/data/content.json . If we wanted to add an additional description field to the "Speed dating for web mechanics", that is something that we can totally do within this sprint.

If it's #2 that's desired, that would not be possible to do within this sprint.

Comment 18

[Matt Thompson (@OpenMatt :OpenMatt)]

* Thanks Jbuck. True, all we care about is 1. And Kate just showed us how to edit the Json ourselves to do it. 

* Kat: I think I know have the ability to make your stuff in comment 13 a reality. Write any description or title you want, and we will make them appear. :)

Comment 19

[Brett Gaylor [:brett]]

THE BEST FIX IS SOMETIMES A WONTFIX

Comment 20

[Kat Braybrooke [:codekat]]

Agreed that we only want to do #1 (I can already do #2 in the MakeAPI, shhh) ;)

Matt, can you and Kate show me how to edit JSON files myself? 

If not, it'd be a task of you going into the Etherpads with me, and adding details via the details that are in there.

Comment 21

[Matt Thompson (@OpenMatt :OpenMatt)]

@ Kat: sure. For now, can you just use this exact template / format in the etherpads? This is valid JSON. Then I can paste it in:

"title": "Hold a SEO battle with kids",
"description": "Facilitate this activity to help learners get their websites at the top of Google Search",
"url": "https://mousemeredith.makes.org/thimble/seo-battle",
"author": "meredith",
"type": "kit"

Comment 22

[Kat Braybrooke [:codekat]]

Matt, yes I can do this -- question though -- can author and title be our modifications in the JSON, or do they need to correlate exactly with what's in the MakeAPI?

Comment 23

[inactivate account for kate]

They can be whatever you want

Comment 24

[Kat Braybrooke [:codekat]]

Cool thanks Kate. Will dig into the pads now.

Comment 25

[Kat Braybrooke [:codekat]]

Note all: JSON format descriptions will now be added, for every competency, here: https://bugzilla.mozilla.org/show_bug.cgi?id=1025226