add warning blockquote style, carpentries/styles#49

[jsta]

This PR adds a blockquote style for warnings or errors, see #49.

See https://carpentries.github.io/lesson-example/04-formatting/index.html#special-blockquotes for a comparison against other blockquote styles. See https://getbootstrap.com/docs/3.3/components/ for a gallery of alternative icons.

If this looks good to people, I've prepared a PR to the lesson-example repository at: https://github.com/jsta/lesson-example/tree/warningcallout

[fmichonneau]

This looks good. Thanks, @jsta!
I was wondering whether we should harmonize the style with the code warnings from here #455 but I think that the 2 use cases are distinct enough (callout warning in the text vs. warning generated by code) that it's not needed. What do @carpentries/lesson-infrastructure-committee members think?

[maxim-belkin]

What is the motivation for adding this blockquote? What type of information would this blockquote contain?

[jsta]

For me, the motivation is to warn users about a change in the default setting of stringsAsFactors that breaks a lot of existing R lesson content. See datacarpentry/R-ecology-lesson#608 (comment) and datacarpentry/r-intro-geospatial#74 (comment)

[maxim-belkin]

Thank you, Joseph. I think this type of information fits the description of the callout blockquote, so from that point of view we have this type of information already covered. But this is not to say that I'm strongly opposed to introducing this new blockquote. I would, however, like to see some other possible use cases for it so that we don't add something that works in a very specific case only.

[ErinBecker]

I think that distinguishing between “helpful information” = callouts vs. “warning” = potential problems makes a lot of sense. For the SWC shell lesson, for example, I would divide the current callouts like this:

Callout

• Slashes
• Clearing your terminal
• Manual pages on the web
• Other hidden files
• Orthogonality
• Two more shortcuts
• Sorting output
• Two ways of doing the same thing
• Good names for files and directories
• Which editor
• Control, Ctrl, or ^ Key (?)
• Whats in a name
• Wildcards
• etc

Warning

• Command not found
• Home directory variation
• Unsupported command line options
• Deleting is forever
• etc

Dividing things up this way will make it more clear to Instructors where “extra” information (currently in callouts) is necessary vs just helpful.

I might not use the label "warningerr" - maybe just "error"? Or "caution"?

[brownsarahm]

I agree with Erin's distinction. Ways that we can support instructors differentiating through content will help a lot especially for new instructors who are getting used to the material/ format of teaching . etc.

for a label I like "caution" to use a distinct term for a human warning or common mistake from a compiler provided warning or error. Though we might use the "caution" to help people prevent compiler warnings and errors, having distinct terms will help in talking about things in the context of lesson development and maintainence. (after any learning curve to make people aware of the new feature).

[maxim-belkin]

Makes sense. I especially like the idea of using it for things like "Deleting is forever" in the Shell lesson.
.error and .warning are already taken but .caution and .alert are available, I believe

[jsta]

Good discussion here! I favor .alert and pushed this change to the PR. Happy to go with .caution if people prefer.

[maxim-belkin]

@jsta, could you please squash the commits, add Fixes carpentries/styles#49 to the message body on a separate line and remove #49 from the title (or replace it with a full link carpentries/styles#49)? -- otherwise this issue will be attached to all issues 49 in all Carpentries lessons (that use this repository).

[maxim-belkin]

and one last comment from me -- I think classes are sorted alphabetically, so if you're adding .alert put it first, and if people decide on .caution -- put it after .callout

[fmichonneau]

thank you everyone! I think this is going to be a very useful to the lesson template.

[maxim-belkin]

🎉

I have to clarify one thing: Fixes user/repo#issue-number should be in the message body rather than title for it to automatically close an issue -- that's why it didn't work this time (I closed that issue manually).