search

aiven / devportal

Resources for users of the projects on the Aiven platform
https://docs.aiven.io
Creative Commons Attribution 4.0 International
60 stars 53 forks source link

Embedded videos on devportal #1488

Closed laysauchoa closed 1 year ago

laysauchoa commented 2 years ago

It makes sense to have some of the videos embedded so the user does not need to go to youtube in order to watch it.

Check if there is an extension for that which we can use it. Just the key videos should be considered for this to not make the website noisy.

lornajane commented 2 years ago

This is an interesting idea but I'm not sure of the goal. The first step should be to propose some requirements for discussion before anything is implemented.

laysauchoa commented 2 years ago

Sure, this is an investigation ticket first.

wojcik-dorota commented 2 years ago

@lornajane @laysauchoa I support this idea. I can see quite a few screenshots in devportal how-tos. First thing is to limit their number, but if we go one step further, we can get rid of them by replacing a few images with one short mp4. This way the article would be quicker to update, shorter, and more attractive and approachable to the user. I even tried to include already some raw html video tag but it obviously didn't work. Is that possible to enable some video shortcode for devportal? I guess it would need some sphinx plug-in/configuration? Thank you for raining that issue :-)

.. raw:: html

    <video width="500px" height="500px" controls="controls"/><source src="_static/clickhouse-create-service.mp4" type="video/mp4"></video>

Here's the output - the video is blank...

image

lornajane commented 1 year ago

Let's put together some requirements and talk about the goals for this, we have a policy of not including video but we can revisit the decision factors and discuss this again, certainly! But let's discuss before investing more time in this, currently we should not be including video or animation content in our documentation.

lornajane commented 1 year ago

Let's put together some requirements and talk about the goals for this, we have a policy of not including video but we can revisit the decision factors and discuss this again, certainly! But let's discuss before investing more time in this, currently we should not be including video or animation content in our documentation.

laysauchoa commented 1 year ago

My conclusion is that is possible to include videos in devportal. You can check out an example in the flink page: https://docs.aiven.io/docs/products/flink/getting-started.html

wojcik-dorota commented 1 year ago

Yes, indeed, but you can only link to videos (YouTube, Vidyard, etc), you still cannot upload mp4 into the repo and use such a video file in your article.