Skip to content

[Docs] Add video page creation guidelines to the Contributing Guide #512

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

Open
5 tasks
zihanKuang opened this issue Apr 29, 2025 · 0 comments · May be fixed by #520
Open
5 tasks

[Docs] Add video page creation guidelines to the Contributing Guide #512

zihanKuang opened this issue Apr 29, 2025 · 0 comments · May be fixed by #520
Assignees
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown

Comments

@zihanKuang
Copy link
Contributor

Description

Meshery Docs should include clear instructions on how to create individual video pages. Currently, contributors may not know:

  • Where and how to add a new video page.
  • Which frontmatter fields or shortcodes are required.
  • How to maintain consistency across different types of documentation (e.g., guide, task, event, video, blog).

Checklist

  • A new section titled Creating a Video Page is added to the Contributing Guide.
  • The section includes:
    • Required frontmatter fields for video pages (e.g., title, video_link, duration, tags, etc.).
    • How to use the custom shortcode (if applicable) to embed videos.
    • Guidelines on where to place video markdown files within the repo.
@zihanKuang zihanKuang added area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown labels Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation framework/hugo help wanted Extra attention is needed language/markdown
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants