Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
Create video equivalents of each of the task tutorials in the user guide. And then embed (preferred) or link to (alternative) the videos within each of the task tutorials.
Why video?
- Different people learn in different ways, some are more visual learners, and having the ability to watch as someone else navigates the steps required to complete a task is more helpful than either reading instructions, or looking at screenshots
- Video can also be beneficial for auditory learners
- Video allows the user to see important elements of the UI that may not be covered by screenshots
- Some people prefer watching a video over reading a page of text
- Adding video has the potential to expand the audience for the guide, and thus Drupal, and thereby help to get the next generation of Drupal users and developers started off via Drupal.org instead of via external sites
Proposal
Start by adding video/screencasts to all task pages in the guide. These are particularly well suited for video as they are all fairly self contained, and almost all demonstrate something you can achieve by navigating through the Drupal UI.
Drupalize.Me is in the process of creating videos that mirror the content of the task tutorials in the user guide. We’re using the written version as a template for creating a script and storyboard for the video, then walking through the steps outlined in screencast format. We intend to publish these on our site for free. We would like to also make these videos available to be embedded into the user guide content on Drupal.org once they are completed. And if the community thinks this is a good idea.
As they are a derivative of the existing user guide content, the videos we create will all be made available via the Creative Commons license. They'll be Drupalize.Me branded consistent with other material that we've made freely available on YouTube in the past.
Each video will consist of:
- A short tutorial title/branding pre-roll at the start
- An intro slide that is aprox. 5-10 seconds long and gives the name/description of the video
- A goal slide that states the goal of the video
- A prerequistes slide that states both the knowledge, and site, prerequisites you'll need to have learned before proceeding
- A short usually 2-4 minute screencast walking through the steps as outlined in the written version of the tutorial. These mostly use the text of the tutorial with some alterations to make it flow better when read out-loud and with the pacing of video
- A recap slide
- A 5 second creative commons post-roll.
- 1 second Drupalize.Me logo
Example video: 4.3 Installing a Module - https://www.youtube.com/watch?v=HymQsDOcT3E
Topic in the User Guide this corresponds to: https://www.drupal.org/docs/user_guide/en/config-install.html
Example video: 4.6 Configuring the Theme - https://www.youtube.com/watch?v=CEi3i1YGOs0
Topic in the User Guide this corresponds to: https://www.drupal.org/docs/user_guide/en/config-theme.html
(This example shows how we are using the Anytown Farmers Market guiding scenario in our screencasts.)
At the moment we're working through creating video for each of the task tutorials. We intend to also create video versions of the concept tutorials, likely as short presentations with slides/visuals, at some yet to be determined point in the future. But the task tutorials felt like the more useful ones to create initially.
As an artifact of the video creation process we'll have written scripts, and slides, for each video which could potentially be added to the official user guide project in some way as well. This would allow for others to potentially reuse those assets to record their own variations, and/or help keep things up-to-date.
Potential issues
Here's a couple of the things I think we should consider before adding video to the guide. And my ideas about why they might be non-issues in this case. I would love to hear other people's concerns.
Embedded videos: We'll need to determine how to embed the videos into the HTML versions of the guide pages that are displayed on Drupal.org. We plan to publish all the videos on YouTube, so we could potentially embed the YouTube player. This could be either by adding some additional code to the file for each tutorial that has a video, or by adding some additional processing in the import process that's used to generate the Drupal.org pages that maps videos to pages and inserts the appropriate embed code.
Ebook output: Videos will not translate well to e-book format, and so if they are embedded into guide pages stripping them out when generating ebook output will need to be taken into account.
Keeping the videos up-to-date: When new versions of core are released, or bugs are discovered in the existing content videos would need to be updated to reflect those changes. This will in almost all cases require re-recording some or all of the video (especially if a different person is creating the new version), along with editing, updating captions, and reprocessing the video into a publishable format.
Because the videos will also be in use on the Drupalize.Me site we will continue to keep our versions (and the versions in our YouTube channel) up-to-date in accordance with Drupalize.Me's current practices. Our policy is to keep things up-to-date with the currently released minor version of core (eg. 8.3.0, 8.4.0) by updating existing material after the release is made. Changes made to the content of any tutorial that requires updating a video wouldn't be included until the video is updated for a minor release.
Translation: The videos will all be recorded in English. We will create transcripts and captions for the videos as well. In this case we could make the .srt transcript files available for translation should anyone want to provide translated sub-titles for any of the videos. Drupalize.Me can also help facilitate the translation process using the tools we already have access to for captioning them (using dotSub). Like with anything translation, these would need to occasionally get updated if/when the individual videos are updated.
I would like to hear other people’s thoughts about:
- The possibility of adding videos, and having those video be created by Drupalize.Me to the user guide pages on Drupal.org and wherever else they are published
- Thoughts or concerns regarding any of the potential issues above, or others that I’m not thinking of
- Any additional pros/cons of adding videos
I'm pretty sure this is clear already, but just in case it's not: Full disclosure: I am both a maintainer of the Drupal 8 User Guide project and an employee of Drupalize.Me. So, it's important to me that we build consensus around implementing (or not) this idea that includes voices other than just mine. :)
| Comment | File | Size | Author |
|---|---|---|---|
| #33 | interdiff.txt | 1.99 KB | jhodgdon |
| #33 | 2923453-video-guidelines-v6.patch | 10.2 KB | jhodgdon |
Comments
Comment #2
jhodgdonLet's do it!
Will post later with thoughts on the details when I have time to think about them more. :)
Comment #3
jhodgdonOK, I took some time to read through this proposal in more detail, and to watch the sample video.
A few thoughts:
auto_screenshots/backups/en
The subdirectories correspond mostly to the chapters in the User Guide; for instance, doBasicConfig contains the backups after following the steps in the chapter about Basic Configuration.
Comment #4
jhodgdonOh duh, installing a module is before we configure the theme, so ignore item 1 on my previous comment. :)
However, the info about the db/files backups may still be useful to you or anyone wanting to make videos.
Meanwhile, a micro edit to the issue summary: adding a link to the User Guide page that you posted the sample video for.
Comment #5
jhodgdonPosted https://groups.drupal.org/node/517853 to solicit more input, and https://twitter.com/poplarware/status/930493120738766850
Comment #6
eojthebraveHey Jennifer, thanks for the feedback
We've been using the db/files in the user guide project as part of the process for creating the videos already. Helps make sure things are consistent, and allows us to more easily jump around and not have to record things sequentially which is nice.
Regarding embedding vs. linking. I feel the same way. Embed a link in the content at most, and then perhaps use the import process into d.o. to expand that to an actual YouTube embed. Our intent for the Drupalize.Me site is to use a CSV file that maps a video to a file in the user guide. And then during the import process (ours uses the asciidoc_display module + a custom migration) to use the CSV file to figure out which if any video to embed and inject some extra code into the page. And like you said, seems like it would be good to get @drumm or others from the DA to be a part of that discussion. I think for now, we can leave the technical implementation details for another issue and just use this one for discussion of whether or not someone sees a link, or an embedded video, when visiting a page on drupal.org.
Regarding translation. YouTube does have some tools for creating captions, though I've not ever actually used them. For Drupalize.Me content we use a tool called dotSub, and hire someone to manually generate the time coded transcripts. This results in a .srt file, which is basically the standard for all of these types of tools. Those .srt files can be uploaded to YouTube. And, they can translated. dotSub has a tool you can use for translating things that we've used in the past. But I'm sure there are other options as well.
The video I linked to in the example does not have a transcript yet. So you can't actually preview that functionality. However, I think you can anticipate that this would look, and function, just like any other video on YouTube that has captions and translations.
Thanks for Tweeting and posting about this on g.d.o. too.
Comment #7
jhodgdonSounds good, thanks for the explanations!
Regarding embed vs. link... The problem with embedded videos that I have seen is that sometimes (on some browsers or for some magic reason I don't understand, or maybe it's always?) they start playing automatically. If we can somehow have an embedded video that doesn't auto-play, then I would definitely be for embedding them. If the video must auto-play, I would rather see a link. But generally, having the video right there would be better, because it's one less step and also more likely to get noticed.
If I didn't already say so, I agree with all your reasoning: many many people (not me, but many others) really prefer to learn from videos, so having them readily available in the User Guide seems like a good thing, as long as they don't get in the way of non-video-preferring readers. :)
Comment #8
Amber Himes MatzI uploaded a 2nd example video showing how we are using the Anytown Farmers Market guiding scenario in our screencasts.
I also updated the issue summary with a link to it.
Example video: 4.6 Configuring the Theme - https://www.youtube.com/watch?v=CEi3i1YGOs0
Topic in the User Guide this corresponds to: https://www.drupal.org/docs/user_guide/en/config-theme.html
Comment #9
eojthebraveThis is generally a feature of the video player, and when it does autoplay it's because someone specifically coded it to do so. Some browser are starting to block this, so that regardless of the settings in the player the video will not automatically start playing. I agree, it's super annoying.
The YouTube player defaults to not using the autoplay feature for embedded videos.
Here's an example:
With a bit of CSS this player can probably be made to be responsive. And, you can view a complete list of options for the embed code here https://developers.google.com/youtube/player_parameters
Note: This works because I have access to post Full HTML. In case anyone is wondering how I'm able to embed the video above. :P
Comment #10
jhodgdonNice. The video in #9 doesn't auto-play for me.
So. Next steps?
I think maybe we should leave this open for discussion for a few more days, to see if anyone from the community has any objection to the plan or suggestions for improvement, etc.
So maybe after Thanksgiving, we should discuss with the drupal.org maintainers to see what they think about embedding videos? And then we should get down to the details of exactly how we should do it?
Comment #11
jhodgdonOne more technical question... I'm still a bit confused about captions and translating, not being a video person particularly... Assuming that we have a video for a particular topic, and someone has provided translations into languages X, Y, and Z, and Drupalize.me has added the translations to the video (however that is accomplished and I probably don't need to know the details :) )...
Will each translation be in a separate video, or will all the captions and subtitles for all languages be available from the same video at the same URL (and embedded the same way)?
Comment #12
eojthebraveYeah. I think it would be good leave this open for discussion and see if anyone else weighs in on this.
I'll be on vacation, and so mostly not doing Drupal stuff for a couple of weeks. But when I'm back in December we could start the process of figuring out an actual implementation plan with drupal.org maintainers.
We're also still in the process of recording and editing the videos. So it'll be probably mid December before those are all completed.
As for the translations (and closed captions for that matter). They are typically stored as SRT files. Which are basically just text files which includes lines of text with a start and end time code for that line. The player is then fed a list of any available SRT files and will provide the user with an option to choose from those available. When one is chosen, the player deals with reading in the SRT file, and using the time codes in the file to align the text in the file with what is being spoken on screen. And then just displays that text.
So, you have 1 video file, with any number of subtitle files. So effectively all the translations are in a single video with a utility that allows you to choose which you would like to use. Here's an example on YouTube - https://www.youtube.com/watch?v=QRS8MkLhQmM - you can turn on captions with the CC button, and then choose a language by clicking the gear icon in the player.
We use dotSUB to allow someone to watch the video and provide the original English captions. It has some fancy tools for handling timecoding, and reviews, and other workflow things. We then get an SRT file. That SRT file can be translated. You could probably just open the file and start editing if you wanted too. But, we also use dotSUB for this again because of the tools they have on their platform for peer review. I honestly have no idea if there are better tools available. And if people wanted to use something different to perform that translation that should be totally fine. As long as it can spit out and SRT file when it is done.
Comment #13
vijaycs85+1 to have videos. It would be great help to have videos. Some pointers are:
1. I think adding videos in separate section as video library with same structure as document would be great. Then it would be very similar to any video based tutorial site. This way people can learn move from beginner -> expert levels by following videos.
2. Is there a way to open source the whole video creating part? - We can have a user guide on how to create your own video :)
3. We could also reach out to other video providers (like Brightcove) as it can scale really good without any ads and we have integration modules which allows to directly upload the videos from d.o ( well, we might have one for YouTube as well) and new versions same video could be possible(Where as youtube provide another video link?)
Comment #14
jhodgdonI think that having the video library separate from the User Guide would make it less likely people would find them. I think for optimal discoverability, the video(s) covering a particular topic should be on the same page as the text/screenshots covering the same topic. My reasoning:
- If someone finds the video they have also got the text, and vice versa.
- Links to prerequisites and related topics and further reading are more difficult in a video, so it's helpful to have the text page there to have the links (which would take you to the text topic page, plus any videos it might have).
- If not all topics have videos (such as the Concept topics for example), you can read some topics and watch some topics, but still preserve the order/learning.
- I think we also want the video links in the PDF and other ebook versions of the User Guide. That would not be possible if the video library was in a separate place from the User Guide itself. The video links need to get into the AsciiDoc source of the Guide.
- We actually have (or at least had, at one time) a section in the Drupal.org docs for videos, which suffered from many of the problems/concerns listed here.
Regarding open-sourcing the videos: As noted in the proposal, the videos will be released under Creative Commons license (since they are a derivative of the User Guide content), and will have transcripts available. Certainly anyone else could also create videos. Drupalize.me has committed to actually making a complete video series for at least the task topics, and keeping them updated. At least for now. But we should not exclude anyone else from doing the same thing and also being included in the User guide.
So. Some random ideas (not necessarily compatible with each other):
a) Maybe we should add an optional section to the User Guide topic templates called something like "Videos covering this topic", and have a process for people to submit links for that section, if they create or find a good video. But I think we should curate/review each video before its link is added, because we don't want to include videos that don't actually cover the topic, have lots of ads/promotions, require an account to view, violate the Drupal Code of Conduct, are of very low quality, etc. I think there were at one time criteria on the drupal.org video section about this; we should check on that.
b) Maybe we should maintain a list (Open Office spreadsheet?) in the Git repo for this project of available videos for each topic, when they were last updated, where the transcript can be found, what translations have been done, and other information.
c) We should encourage anyone creating videos to subscribe to the Google Groups email list we have for notifying translation groups about updates to topics. If a topic text or screenshots get updated, presumably videos would need updates as well.
d) If we have more than one video available for a given topic, does it still make sense to embed players for all of them when we display on drupal.org?
Comment #15
Amber Himes MatzIn the videos, we reference the written version of the tutorial to find links to prerequisite tutorials, additional resources, and related tutorials. So it would make the most sense to have the video embedded in the written tutorial.
Comment #16
eojthebraveEven if we don't end up doing this on drupal.org, sites like YouTube allow you to organize things into a playlist or collection. And a viewer could then watch things one right after the other.
The issue, at least for now, is that we would initially only have videos for the task topics, and there is content in the concept topics that is important for someone to grasp before moving on in many cases. So just watching the videos, and not reading the text, won't be a perfect experience. It won't be bad either though.
This is probably worth re-visiting once there is video for all pages. And figuring out a way to allow people to sort of queue up a series of videos and watch them all in sequence.
Yes~ish. We can release the finished materials like the edited video, and raw materials like the scripts and slides, under Creative Commons so that people can alter, and remix them. In most cases any alterations to a video would need to either 1.) involve the original creator so that you can edit just a sub-section without a jarring transition to another voice, or 2.) require a complete re-recording and editing of the video. In which case the creator is likely to have their own set of preferred tools.
It's probably also worth noting that we're talking specifically about the pages in the user guide here https://www.drupal.org/docs/user_guide/en/index.html, and not community documentation pages located under https://www.drupal.org/documentation. Though there's no reason people can't add video to those as well, that's not the scope of this issue.
As for a guide for creating videos. It might be worth at least identifying criteria for videos that are included in the user guide for consistency sake.
I'm not opposed to looking at other options. But my gut says YouTube will be the lowest barrier to entry both for getting this done (since it's what I have the most experience with currently) and for future contributors (it's certainly the most ubiquitous platform).
Regarding adds. The person (or org) who creates the video on YouTube can opt-out of displaying ads on the videos. https://support.google.com/youtube/answer/6332943?hl=en. Which we do by default for all the Drupalize.Me content, and would of course do in this case as well.
Jennifer, I'm totally open to looking into maintaining a list of videos related to each page. Though, I also think it's worth distinguishing between a video like what is proposed here that delivers exactly the same content as what is on the page, and one that is say a presentation that maybe covers some, but not all of the same content, and doesn't follow the guiding scenario. The later I think would be potentially confusing to have embdded in the page vs. just linking to them and making it clear that this is "additional related material".
Comment #17
Amber Himes MatzJust a note about ads. Actually, we do have ads displaying on Drupalize.Me videos, but I think we can turn that off for User Guide videos, at the very least. (Ads are currently on for the 2 example videos we provided in this issue.)
Comment #18
jhodgdonRegarding the spreadsheet/list of videos, I was just thinking about it in terms of being useful for the translation teams. Maybe it would just be a Google sheet somewhere with columns:
Topic | Topic last updated date | Video last updated | ES translation last updated | HU translation last updated | ...
Or something like that. I don't know if it's useful or not.
So...
Just one more thought. It takes a *lot* of work, equipment, experience, etc. to make actually good videos. Drupalize.me has all of the necessary equipment/experience, has a track record of making excellent Drupal videos, and is offering to spend the time to make videos that exactly match the content of the User Guide task topics. Which is great!
There are certainly a small handful of other enterprises out there that have similar expertise. If any of them wants to also make videos that exactly mirror the User Guide content, then I don't think we should play favorites and only list Drupalize.me's videos in the official User Guide. I haven't seen anyone else offer to do this yet, but if they do, I think we could list or embed both videos on each topic page.
However, I totally agree that we shouldn't give equal preference to lower-quality videos, or videos that cover similar material but aren't trying to exactly mimic the content, page-by-page, step-by-step, of the User Guide. My thought was that we would highlight exact-mimic videos by putting them in a section on the page dedicated to listing only videos that exactly mirror the topic content, vs. the section that we already have that lists additional resources (there is no reason we can't list videos there if we aren't already doing so, in addition to the links to blog posts, drupal.org documentation pages, etc. that we already have for sure).
And by the way I found the existing video library on drupal.org:
https://www.drupal.org/videocasts
There's also a guidelines page about what to list there, plus some tips on creating videos and a list of video creating/editing resources:
https://www.drupal.org/node/62196
Comment #19
add1sun CreditAttribution: add1sun commentedFor the record, the Installing a Module video does and did not have ads enabled. I removed ads from the other one. Unfortunately, YouTube puts ads on by default so we have to remember to turn them off for each video, which didn't happen on that one as folks were pulling things together to get this issue posted. Our standard policy is to turn ads off for all of our YouTube videos.
Comment #20
eojthebraveYup, totally agree. If someone else wanted to create videos that reflect the written content of the user guide we should make sure we're not giving special preference to anyone. If that does happen in the future I think we can either choose to embed both, or possibly re-think the UX altogether as I worry having multiple embeds of essentially the same video on the same page might be confusing. But, we can probably choose to cross that bridge when we get there.
This makes sense to me as well. My suspicion is that it's somewhat unlikely that we'll see anyone creating a whole bunch of these videos that mimic the guide content. Especially once a set already exists. Except maybe if people record them in a different language. But, I'm totally open to the possibility that it might happen and want to make sure we're accommodating to anyone that does.
Listing lower-quality materials in a dedicated section as links, and either embedding, or figuring out a better way to handle multiple/duplicate higher quality stuff seems like a good approach.
Comment #21
jhodgdonOK...
So it seems like the next step would be to make a patch so that what we're discussing here gets put into our templates and guidelines. Then we can proceed to start actually adding videos as they are ready.
Let's see.
We have the templates stored in plain text in the templates directory, and they are also reproduced in the Guidelines document here:
https://www.drupal.org/docs/user_guide_guidelines/templates.html
It doesn't look like we have a guideline anywhere for what to put in each section of the template, beyond what is in the bare template. Maybe we should add a section to:
https://www.drupal.org/docs/user_guide_guidelines/guidelines-writing.html
titled something like "Adding outside links and videos" that would explain which links and videos go in which section?
Perhaps I can take a stab at a patch, to see if I've understood the proposal and discussion so far, and you all can edit/review?
Comment #22
jhodgdonOK, here's a first pass at a patch. I've probably forgotten some stuff... I found that AsciiDoc has a way to do videos, which I haven't tested...
http://www.methods.co.nz/asciidoc/userguide.html#X98
and I haven't looked at the output of this patch or even tried to build it... anyway about to head out the door but I thought I would post this for review.
Note: found a couple of inconsistencies/typos in the templates so I fixed them too (very minor)...
Comment #23
jhodgdonHumph. The AsciiDoc video macro shown on http://www.methods.co.nz/asciidoc/userguide.html#X98 did not work when I put it into a page, so the patch above will need some adjustment. We'll need to either write our own AsciiDoc macro for videos (possible) or figure out another way to do this.
Any comments on the rest of the proposed patch?
In particular:
All of these changes need to be reverted. The rest of the patch is probably OK (I built it on my local site and the formatting is fine for the new sections in the Guidelines book).
Any thoughts on the practicalities of how we should make links to videos? Maybe we should try to make that macro work... Oh, I see, it's only for when you convert directly from AsciiDoc to HTML5. We are converting to Docbook. So ... more research on docbook and videos would probably be good...
Comment #24
jhodgdonHere's a new version of the patch. I got the macro mostly working, though I need to figure out what to do for PDFs. In HTML it works fine -- puts in an EMBED HTML tag, which just works. In PDF it is coming up blank but I should be able to fix it.
Comment #25
jhodgdonWell, this will work: put in both a link and the video embed. :)
Comment #26
jhodgdonOK, one more pass. This macro actually works. In HTML versions of the Guide, it embeds the video and also puts in a link to the video beneath. In PDF, you just get the link.
The part of the patch for formatting.txt shows the syntax:
Comment #27
eojthebraveThanks for looking into the technicalities of getting this working. I haven't actually tested the video embedding + build scripts locally, but I can if you think it's worthwhile.
Couple of thoughts on the proposed changes to the templates and guidelines:
Should we add "Site prerequisites (task topics)" to this list as well?
Should we add an example here, and in other blocks that have the same text? "video::https://www.youtube.com/embed/HymQsDOcT3E[title="Name of video"]
" Might make it easier for someone to just uncomment, and update rather than having to remember the exact syntax. We do this in most other comment blocks like this showing how to make a link and/or the format we want lists to be in.
Comment #28
jhodgdonThanks for looking at the patch!
Regarding item 1 in #27, I didn't put Site prerequisites in there because it generally isn't a simple list of links to other topics... but yes, you're right, it generally does include links to other topics. An example from block-place.txt:
So we should say something about how this section should tell about things that need to be configured or content that needs to exist on the site, along with links to the topics that cover how to do that.
Regarding item 2, yes that is probably a good idea... We also don't currently have an example of how to do images in the task topic template... or tables... should we add those too? What I mean is, in the Steps section of the template, we have:
but we don't have examples of how to insert images or make tables.
And I don't think you need to test the build scripts unless you want to. :)
Comment #29
jhodgdonOne other thing that I forgot to include in the guidelines, or that we didn't finalize yet, is anything about transcripts, captions, translation, or licensing.
I'd like to propose that we add something about this to the guidelines-writing.txt section where the current patch says:
How about another bullet point(s) saying something like:
* If a video is embedded (instead of just linked) in the guide, it must also be captioned (which will make it accessible, according the https://www.w3.org/2008/06/video-notes[W3C Multimedia Accessibility Guidlines]).
* Embedded videos must also be translatable. [???]
I'm not sure what to say about being translatable. I was thinking that a video would either need to be (a) licensed by ??? with a full transcript and source video (?) provided, so that someone could record a new version of the video in another language or (b) the producer providing the transcript and committing to adding the translations as captions to the video if the translation teams provide them.
But I'm so unclear on the video production process I am not sure how to word this part or if it's accurate? And I wasn't sure how we would want to require that transcripts etc. be provided. Perhaps we should make a README-videos.txt file, which would list links where video source files and transcripts could be downloaded? Are the formats that transcript/translation/caption files go in readable by people or do they require special software? Do we need to provide instructions for translation teams on how to translate video transcripts? Does the video producer need to be involved in translations, or on something like YouTube is there a way for 3rd parties to provide captions for other languages? Many questions...
So Joe or Amber or Addison -- maybe you can write up these guidelines in a way that would make sense?
Comment #30
jhodgdonHere's a new patch. Hopefully addressed #27-29, but definitely needs review on the new section on captions and translations.
Also here's an interdiff from the last version.
Comment #31
eojthebraveWe're still plugging away on getting videos edited. So that part is still in process.
I like this idea. It would also allow a producer to provide additional details that are specific to their workflow regarding incorporation of translations etc.
Yes. The most common format is a .srt file. Which is just a text file with some special formatting that includes a timestamp so that the player can align the string of text with the appropriate place in the video. Here's an example https://drupalize.me/v/captions/file/410c9e9b-d512-4881-87d8-8839a6c0610...
I think this is something we should allow the teams to define themselves. The general process is to load the existing SRT file + video into a tool that allows you to watch the video, view the existing SRT, and provide a translation in a text field. You could just translate the text directly, but having a tool that lets you view the video at the same time can help provide context. There are dozens of tools for doing this. A producer could provide any tooling specific details in the README if necessary.
The producer would likely need to get a translated SRT file and add that into their player. However the player works. Some hosting systems, like YouTube, have ways to allow a producer to crowd source translations and subtitles - https://support.google.com/youtube/answer/6054623?hl=en. But, this is going to be totally dependent on the solution used for hosting/playing the videos.
I'm assuming that this only works for YouTube links? Or does it work for other video sites as well? We might want to clarify that here I could see it causing confusion.
I think it's probably sufficient to say that video producers should make transcripts/captions available for translation. With a license that would allow someone to do so. And be willing to incorporate those translations into the embedded player if they are created.
There are so many different ways that that process can be handled that I don't think we should be trying to document anything more specific.
This might be just nitpicky. In general, I think this all looks great.
Comment #32
jhodgdonOK, all sounds good...
Regarding the video: tag in the AsciiDoc source, it makes a video HTML tag in most of our output formats, so whatever would work there is OK.
Comment #33
jhodgdonHere's a new patch, hopefully incorporating the latest feedback.
Comment #34
eojthebraveThis looks good to me. I think we can go ahead and commit it unless you've got any further thoughts to add @jhodgdon. I'm going to start working on a patch to add some videos and basically go through this process and I think we can make adjustments as things come up.
Comment #36
jhodgdonGreat! I committed this patch. Changed the title and marked it fixed... I think maybe if you want a meta-issue to track adding all the videos, we should start a new issue so it's clean? And if one of your first patches that adds a video also updates the guidelines so that they work better or make more sense, that seems fine to me. Looking forward to this!
Comment #38
jhodgdonI just realized that on this issue, we didn't update the Terms to Translate spreadsheet to add the new heading "Videos" to the list. I'll make that commit now.