carpentries / handbook-beta

Beta version of The Carpentries Handbook.
https://carpentries-beta-handbook-preview.netlify.app/
1 stars 7 forks source link

Guidance on display of external URLs in lessons #201

Open ostephens opened 5 years ago

ostephens commented 5 years ago

Before Library Carpentry lessons formally joined the Carpentries, we had some discussion about the display of URLs in lessons (see https://github.com/data-lessons/library-openrefine-DEPRECATED/issues/54)

tl/dr; should we include full URLs in the lesson visible to the users so they can be read both on screen and in print outs, or should they be done as hyperlinks with sensible link text instead of the full URL displayed

Guidance on this in the style guide would be appreciated

maneesha commented 3 years ago

Tagging @serahrono as I think this falls into accessibility work she is doing.

bencomp commented 1 year ago

I believe URLs are automatically shown in full when you print lesson content. (At least in the old infrastructure they were.)

So the "lemma" on links in the style guide applies, in my opinion: use meaningful text as link text, not URLs.

maneesha commented 1 month ago

@elletjies Do you want to keep this issue active in the new handbook? If it is no longer relevant, we can close this issue.

Note for now, would just be moving the issue to the new handbook. We don't need to create new resources or materials yet.

Asking you as this is accessibility related; not sure who the best person to ask for this would be.

elletjies commented 1 month ago

@maneesha could we move it to the new handbook so that CET can have a deeper discussion?