Needs work
Project:
Rain
Component:
Rain Features
Priority:
Normal
Category:
Feature request
Assigned:
Unassigned
Reporter:
Created:
15 Oct 2019 at 20:04 UTC
Updated:
19 Oct 2020 at 17:57 UTC
Jump to comment: Most recent
We currently only have a couple of fields with help text. We will want to supply inline help for each field that ships with Rain Features to provide better instructions for editorial users.
Google Sheets:
https://docs.google.com/spreadsheets/d/1W-AhgBRXjdb6xtvQ28URqDjvyjoSmA3d...
Comments
Comment #2
BeckyCierpich commentedI took a stab at drafting some help text. I think that if one could log in as a user and experience the interface, it would become clearer what these fields refer to and consist of and then the text could be further refined.
Author - Select the author or authors of this article.
Content - Select the paragraph or paragraphs you wish to add.
Dates - Select the date of publication. Select nothing to use the current date and time.
Image - Upload an image to go with this article.
Link - Enter a link to supporting content.
Metatags - Add metatags for this article.
Product Description - Enter a description of this product.
Product Media - Add a media item from the library, or upload a new one for this product.
Profile Media - Add a media item from the library, or upload a new one for this profile.
Resource Type - Select the type or types of resource.
Short title - Enter a short title for this article.
Subhead - Enter a subhead for this article.
Summary - Enter summary text for this article.
Tags - Select a tag or tags for this article.
Thumbnail - Select a thumbnail for this media reference.
Webform - Select what type of webform to add.
Answer - Enter an answer to the question.
Author - Select the author or authors of this article.
Body - Enter the body copy for this article.
FAQ Items - Select the FAQ item or items to be included in this article.
Header tag - Enter the header tag for this article.
Link - Enter a link to supporting content for this article.
Map - Enter a link to the map that supports this article.
Media - Add a media item from the library, or upload a new one for this article.
Media Items - Select a media item or items from the library, or upload new ones for this article.
Promo - Select a promo for this article, or create a new one.
Question - Enter a question.
Quote - Select a promo for this article, or create a new one.
Short title - Enter a short title for this article.
Subhead - Enter a subhead for this article.
Summary - Enter summary text for this article.
Title - Enter a title for this article.
View reference - Enter a view reference for this article.
Webform - Select what type of webform to add.
I would recommend considering adding suggested character counts too, for relevant fields.
Comment #3
drupalninja99 commentedThis is a great start Becky! I think we want to be a little bit more descriptive in the help text. I understand some of this could be unfamiliarity with what these fields do. For example, the short title is an abbreviation of the title that will be used in instances with limited character accounts to avoid truncation.
I also think we don't necessarily need verbs to start the description since it's implied that the user will be entering or selecting something when they interact with the field.
Comment #4
drupalninja99 commentedMade some updates to the spreadsheet:
https://docs.google.com/spreadsheets/d/1W-AhgBRXjdb6xtvQ28URqDjvyjoSmA3d...
Next step is to add to a PR.
Comment #5
drupalninja99 commentedPR: https://bitbucket.org/mediacurrent/rain_features/pull-requests/34/issue-...
Added PR here, will still need testing.
Comment #6
drupalninja99 commentedI left this PR open too long and now it needs updating but is ready to be worked on.