content icon indicating copy to clipboard operation
content copied to clipboard

Issue with "Using the Web Animations API": make clear that examples are recordings and not working examples

Open amateurd opened this issue 3 years ago • 12 comments

MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API

What information was incorrect, unhelpful, or incomplete?

The article itself is good. Unfortunately, the examples are illustrated with GIF animations and don't use the animations API at all as far as I can tell. The presence of the code implies that the animation related to it has been generated using the code shown.

Why it matters? If you search for "Web API animations examples" and find this page it suggests that Web API animations are being shown. It's misleading because if you use a browser which doesn't support them (Web API animatons) they still appear to work. At the very least it should make clear that these are pictures and video clips of something and not actual working examples.

Specific section or headline?

Example anmations

What did you expect to see?

WebAPI animations

Did you test this? If so, how?

Looked at the HTML source

MDN Content page report details
  • Folder: en-us/web/api/web_animations_api/using_the_web_animations_api
  • MDN URL: https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API
  • GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/web/api/web_animations_api/using_the_web_animations_api/index.md
  • Last commit: https://github.com/mdn/content/commit/d3c38334923570ada25766f77212b2e808fdebc5
  • Document last modified: 2021-10-15T17:04:17.000Z

amateurd avatar Nov 05 '21 16:11 amateurd

If I understand correctly, @wbamberg suggested moving the code for these examples into mdn/content as live samples.

Am I right in thinking that would require permission from the author, Rachel Nabors?

ninevra avatar Feb 07 '23 02:02 ninevra

If I understand correctly, @wbamberg suggested moving the code for these examples into mdn/content as live samples.

Am I right in thinking that would require permission from the author, Rachel Nabors?

I think we should ask, yes. @rachelnabors , we would like, please, to move the examples you wrote for the Web Animations API (https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Using_the_Web_Animations_API) into mdn/content, rather than linking to codepens. This would make it much easier for us to maintain these examples. The examples on MDN would then be public domain (CC0) per https://github.com/mdn/content/blob/main/LICENSE.md#licenses-for-code-examples-and-snippets . Would you be OK with that? Thank you!

wbamberg avatar Feb 08 '23 19:02 wbamberg

Note that Mozilla contracted Rachel Nabors to write these examples. cc/ @Rumyra

teoli2003 avatar Feb 10 '23 06:02 teoli2003

I have to get back to you on this one as I'm a bit slammed at the moment. What is involved?

On Thu, 9 Feb 2023, 22:29 Jean-Yves Perrier, @.***> wrote:

Note that Mozilla contracted Rachel Nabors to write these examples. cc/ @Rumyra https://github.com/Rumyra

— Reply to this email directly, view it on GitHub https://github.com/mdn/content/issues/10318#issuecomment-1425255794, or unsubscribe https://github.com/notifications/unsubscribe-auth/AABZWERPPTVLX44SLVUHEJ3WWXN43ANCNFSM5HOIHS3Q . You are receiving this because you were mentioned.Message ID: @.***>

rachelnabors avatar Feb 10 '23 17:02 rachelnabors

Hi @rachelnabors 👋 - all we need from you is permission to copy the code from your codepens into MDN - then we cn embed them into the animation pages - we can do the work, so nothing more would be required other than an agreement that these examples would then sit under CCO license (hope you're good!)

Rumyra avatar Feb 14 '23 10:02 Rumyra

Thanks! QQ:

  1. What are the permissions of the CCO license?
  2. Will I be credited in any way for the artwork? --

rachelnabors avatar Feb 16 '23 07:02 rachelnabors

@Rumyra Just checking in! What are the permissions of the CCO license? And will I get a credit for the artwork in some way?

Let's make this happen! Hope you are well!

rachelnabors avatar Feb 27 '23 04:02 rachelnabors

@rachelnabors The information about the license are here: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license#documentation

Pretty much you retain copyright and you don't get specific "mention", but it is possible to track back and determine your contribution if desired.

hamishwillee avatar Feb 27 '23 20:02 hamishwillee

@rachelnabors The information about the license are here: https://developer.mozilla.org/en-US/docs/MDN/Writing_guidelines/Attrib_copyright_license#documentation

Pretty much you retain copyright and you don't get specific "mention", but it is possible to track back and determine your contribution if desired.

Forgive me, but I don't think it's correct to say that the author of a code sample retains copyright. CC0 is a dedication to the public domain; afaik it's as close as legally possible to giving up copyright entirely. It grants all possible permissions without restriction.

ninevra avatar Feb 27 '23 22:02 ninevra

Note: taking a second look, it seems like all the relevant code is currently MIT licensed, if that matters. Unclear about the static images.

ninevra avatar Feb 27 '23 23:02 ninevra

@ninevra Yes CC shares stuff to the public domain, but you retain the rights to do with it what you want, including licensing it elsewhere. You haven't given up copyright, whatever that means. I'm not a legal expert, and if you have any concerns I suggest you try find one.

hamishwillee avatar Feb 28 '23 00:02 hamishwillee

Sounds good. Port it over

rachelnabors avatar Mar 08 '23 04:03 rachelnabors