glossary icon indicating copy to clipboard operation
glossary copied to clipboard

Add and test sign language video in the container page

Open seokho-son opened this issue 1 year ago • 11 comments

Describe your changes

This testing PR is to support #3044 Will see and discuss about the layout from the preview.

Related issue number or link (ex: resolves #issue-number)

  • #3044

Checklist before opening this PR (put x in the checkboxes)

  • [x] This PR does not contain plagiarism
    • don’t copy other people’s work unless you are quoting and contributing it to them.
  • [x] I have signed off on all commits
    • signing off (ex: git commit -s) is to affirm that commits comply DCO. If you are working locally, you could add an alias to your gitconfig by running git config --global alias.ci "commit -s".

seokho-son avatar Jun 12 '24 01:06 seokho-son

Deploy Preview for cncfglossary ready!

Name Link
Latest commit ca40cbea9df0001f4270e3af3c956374ff3a30e4
Latest deploy log https://app.netlify.com/sites/cncfglossary/deploys/66e03aa5bf53e400084286fe
Deploy Preview https://deploy-preview-3194--cncfglossary.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Jun 12 '24 01:06 netlify[bot]

Preview: https://deploy-preview-3194--cncfglossary.netlify.app/container/

seokho-son avatar Jun 12 '24 01:06 seokho-son

Wait, please do not proceed with this yet.

github-actions[bot] avatar Jun 12 '24 01:06 github-actions[bot]

To see where this is in the review pipeline and follow the progress, please look at the definition review board.

github-actions[bot] avatar Jun 12 '24 01:06 github-actions[bot]

hold

  • this PR is WIP. :)

seokho-son avatar Jun 12 '24 01:06 seokho-son

Note: {{< youtube YOUTUBE-VIDEO-LINK-ID >}} is HUGO built-in feature. :)

seokho-son avatar Jun 12 '24 02:06 seokho-son

## Further Reading may not be a necessary header, but I added it to separate the In sign language section from the content above.

I agree. If we're going to roll out a new template with ## Further Reading as a header, I feel like we should specify what it's for. Otherwise, it may become a bit of a junk drawer, which would undermine the effort we're making to highlight the sign language section.

Let us consider dropping "Further reading" in favour of @chalin's suggestion of a "Sign language" section (how ever we want to render that).

nate-double-u avatar Jun 13 '24 23:06 nate-double-u

LGTM 😄

jtjackson avatar Jun 26 '24 13:06 jtjackson

Hello @chalin @nate-double-u, Thank you for sharing your thoughts. The reason I did not use <summary> or another style in the initial proposal was that I hoped the sign language videos would become visible to people more quickly. (It was also the initial layout proposal from the glossary-sign-language and deaf-and-hard-of-hearing WG) For now, I've uploaded a version that incorporates both of your feedback for testing on this page. It would be great if we could all review it together and align our thoughts.

https://deploy-preview-3194--cncfglossary.netlify.app/container/

  • Using <summary> to hide/open the video content:

    • Pros: Emphasizes the main content of the glossary.
    • Cons: Requires an additional click to access the sign language video. (It might not be immediately apparent on the page that the glossary has started supporting sign language)
  • Providing it at the end under an H2 or H3 header:

    • Pros: The opposite of the above method.
    • Cons: The opposite of the above method.

I would also appreciate the opinions of others like @CathPag @jtjackson.

seokho-son avatar Jun 26 '24 14:06 seokho-son

I prefer the second option. What do we need to proceed here? @seokho-son @nate-double-u @CathPag

iamNoah1 avatar Sep 10 '24 12:09 iamNoah1

I prefer the second option. What do we need to proceed here? @seokho-son @nate-double-u @CathPag

I would like to be notified as well for the next steps.

Deafveloper avatar Sep 10 '24 19:09 Deafveloper

@seokho-son As per the discussion in the last DHHWG meeting on November 26th, we have unanimously agreed on the 2nd option, having the video placement at the bottom with the H2 header. We'd like to have the video being visible without the ability to collapse/hide it as it's our goal to raise sign language awareness.

Also, I'm in favor of retaining the Hugo shortcode for YouTube video ID as it'd make it easier for anyone to contribute.

Now that the Sign Language Style Guide has been pushed to the main, we're going to start upload the appropriate video contents to the YouTube playlist. I believe 5 videos would suffice before we can officially publish the sign language feature in the blog.

CCing other approvers here as I'm working on getting myself added as an approver: @jtjackson @Deafveloper @dcdavisintech

bashtheshell avatar Dec 12 '24 15:12 bashtheshell

Thank you for sharing the DHHWG meeting results, @bashtheshell. The voting results from the last maintainer meeting (CC: @iamNoah1, @jihoon-seo, @nate-double-u, @seokho-son) also favored the "bottom with the H2 header" style for better visibility. Let’s finalize it this way. (Of course, the style itself can evolve through future contributions.)

To bring the sign language feature live quickly, I suggest utilizing this PR. Once the 5 video links are organized, please share them in a comment. I’ll update the PR accordingly.

seokho-son avatar Dec 17 '24 03:12 seokho-son

Hi @seokho-son. I know only 5 was asked, but here are the 6 YouTube videos ready to go live. Thank you!

bashtheshell avatar Jan 27 '25 18:01 bashtheshell

Hi @seokho-son I wanted to see if you're able to take a look at the latest videos and update the PRs accordingly. If there are any blockers, please do let me know what needs to be done to get things going again.

jtjackson avatar Feb 25 '25 19:02 jtjackson

Hi @jtjackson, I don’t see any blockers. LGTM. I'll open a PR to the main branch to apply those six videos (for the English docs only).

I'm planning to use the main branch to simplify the upcoming contribution workflow. I believe the sign language team doesn’t need to use the dev-sign branch.

That PR will serve as an example of how to include new videos from contributors.

seokho-son avatar Feb 27 '25 02:02 seokho-son

Current PR is to test (PoC) layout with sign language videos.

  • #3406

will officially include the Sign Language feature to the Glossary. :)

seokho-son avatar Feb 27 '25 06:02 seokho-son

Great work @seokho-son! 🙌🏻 Btw, here's an alternative proposal for the shortcode: #3408. Feel free to copy over whatever you need.

chalin avatar Feb 27 '25 22:02 chalin

@seokho-son I feel we can close this one right? As we already have included some sign language videos and this was only to test the layout right?

iamNoah1 avatar Apr 04 '25 09:04 iamNoah1

Yes, we can close this piloting PR. :)

seokho-son avatar Apr 05 '25 06:04 seokho-son