Skip to content

Create contributing video guide #520

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
May 7, 2025

Conversation

vishalvivekm
Copy link
Contributor

@vishalvivekm vishalvivekm commented May 2, 2025

Notes for Reviewers

This PR fixes #512

  • moves contributing docs section from kanvas/references to /contributing, and
    • adds Contributing to video gallary guide inside it
  • adds template directory in content/en/videos, set to draft: true
  • adds placeholder img for video cards on index pages.

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Vivek Vishal <[email protected]>
Copy link

netlify bot commented May 2, 2025

Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name Link
🔨 Latest commit 171d18e
🔍 Latest deploy log https://app.netlify.com/sites/bejewelled-pegasus-b0ce81/deploys/681bb2d71c05d30008928b08
😎 Deploy Preview https://deploy-preview-520--bejewelled-pegasus-b0ce81.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.

@pontusringblom
Copy link
Contributor

Draft...

@pontusringblom
Copy link
Contributor

Not ready for review.

@pontusringblom
Copy link
Contributor

Ha! This isn't even a draft.

Copy link

github-actions bot commented May 4, 2025

Checking in... it has been awhile since we've heard from you on this issue. Are you still working on it? Please let us know and please don't hesitate to contact a MeshMate or any other community member for assistance.


        Be sure to join the community, if you haven't yet and please leave a ⭐ star on the project 😄

@vishalvivekm vishalvivekm marked this pull request as ready for review May 6, 2025 14:29
vishalvivekm and others added 4 commits May 7, 2025 03:27
Signed-off-by: vishalvivekm <[email protected]>
Signed-off-by: vishalvivekm <[email protected]>
Signed-off-by: vishalvivekm <[email protected]>
@zihanKuang
Copy link
Contributor

Hi @vishalvivekm ,

The contribution documentation structure looks good overall.

I found the title "Contributing Videos" a bit confusing. At first glance, I thought it was a guide on how to make videos (like choosing topics or recording tips), rather than its actual focus on how to contribute video-related documentation or add videos to our gallery.

To improve clarity and consistency, here are two possible suggestions:

  • One option is to move the specific guide for adding videos directly under the main "Contributing to Docs" section. This would make it really clear that contributing these videos is considered a part of our overall documentation efforts.
  • Alternatively, if we prefer to keep "Videos" as a separate, top-level contribution category, we should probably rename the current "Contributing Videos" section title to something less ambiguous (perhaps "Video Gallery Contributions" or similar).

What are your thoughts on this? 🤠

@vishalvivekm
Copy link
Contributor Author

vishalvivekm commented May 7, 2025

What are your thoughts on this? 🤠

Hi @zihanKuang, thank you for your feedback.

"I found the title "Contributing Videos" a bit confusing. At first glance, I thought it was a guide on how to make videos (like choosing topics or recording tips), rather than its actual focus on how to contribute video-related documentation or add videos to our gallery."

Yeah, I acknowledge it being the case. I renamed it to Contributing to Video Gallery.

one option is to move the specific guide for adding videos directly under the main "Contributing to Docs" section

Makes sense, instead of having another section dedicated to "Contributing Videos", We can have just one section "Contributing to Docs" and move the "adding videos" guide to it.

There's a To-do:

  • The existing contributing to docs guide, is fairly long and is in need of being split "between mechanics and style guide.", as rightly noted by Lee.

@vishalvivekm vishalvivekm merged commit f729f8d into layer5io:master May 7, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Add video page creation guidelines to the Contributing Guide
3 participants