Skip to content
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

[Proposal]: Update documentation with a containerized application example (most likely the "help/" section) #421

Open
4 of 6 tasks
alessio-locatelli opened this issue Oct 8, 2024 · 0 comments
Assignees
Labels
COMMUNITY HELP REQ 🆘 Community Help Needed for this Issue/PR DOCS 📜 Issue/PR is related to vidgear docs. PROPOSAL 📩 A proposal/proposition WORK IN PROGRESS 🚧 currently been worked on.
Milestone

Comments

@alessio-locatelli
Copy link

alessio-locatelli commented Oct 8, 2024

Issue guidelines

Issue Checklist

  • I have searched open or closed issues and found nothing related to my idea.
  • I have read the Documentation and it doesn't mention anything about my idea.
  • To my best knowledge, my idea wouldn't break something for other users.

Describe your Idea

To-do:

  • In the docs/help/camgear_ex.md add a link to the ReconnectingCamGear because the second example is battle-tested and can be used as is.
  • Add a link to the vidgear containerized demo project somewhere in the documentation. Add a small note that the code provided can be used as a starting point for beginners, or if someone doubts that a bug is related to the system packages, to compare the behaviour inside a Docker container.

Use Cases

  • A consistent, reproducible environment that people can use to verify possible bugs or try out the code without being overwhelmed by system-specific problems like different versions of ffmpeg and other system packages.
  • An additional example for beginners.
@alessio-locatelli alessio-locatelli added the PROPOSAL 📩 A proposal/proposition label Oct 8, 2024
@abhiTronix abhiTronix added WORK IN PROGRESS 🚧 currently been worked on. DOCS 📜 Issue/PR is related to vidgear docs. COMMUNITY HELP REQ 🆘 Community Help Needed for this Issue/PR labels Oct 8, 2024
@abhiTronix abhiTronix added this to the v0.3.4 milestone Oct 8, 2024
@abhiTronix abhiTronix self-assigned this Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
COMMUNITY HELP REQ 🆘 Community Help Needed for this Issue/PR DOCS 📜 Issue/PR is related to vidgear docs. PROPOSAL 📩 A proposal/proposition WORK IN PROGRESS 🚧 currently been worked on.
Projects
None yet
Development

No branches or pull requests

2 participants