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

Feat: Record Video Tutorial for this Repo! 📺 #23

Open
15 tasks
nelsonic opened this issue Nov 21, 2023 · 3 comments
Open
15 tasks

Feat: Record Video Tutorial for this Repo! 📺 #23

nelsonic opened this issue Nov 21, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or enhancement of existing functionality epic A feature idea that is large enough to require a sprint (5 days) or more and has smaller sub-issues. help wanted If you can help make progress with this issue, please comment! priority-1 Highest priority issue. This is costing us money every minute that passes. T1d Time Estimate 1 Day technical A technical issue that requires understanding of the code, infrastructure or dependencies

Comments

@nelsonic
Copy link
Member

@LuchoTurtle as discussed verbally, we're going to showcase this repo using Video.

Once we've tidied up the repo and landing page a bit #7 + #22
and added the DB (can be SQLite) to save metadata + classification #3 🔋
We should plan to create a Video Tutorial of this project. 🎥

Note: The objective is two-fold:

  1. Make a world class tutorial that anyone can follow.
  2. Showcase your @LuchoTurtle communication & technical skills

Todo

  • Ensure that the instructions in the README.md are fully up-to-date 👀

    • and any external links are correct 🔗
  • Setup your desktop/environment to minimise distraction e.g. don't use your Chrome

  • Follow the example by Code to the Moon: https://www.youtube.com/@codetothemoon/videos e.g: https://youtu.be/jib1wjgIaa4 we have all the equipment necessary to have a similar aesthetic. 😍

  • Record your screen at 1080p (e.g: connect to an external 1080p monitor and record that) 📺

    • Record your voice explaining what you are doing while you are doing it. 🎤
    • Optionally record your Face while you are going through the tutorial 👨‍🏫
  • Re-Create the Project from scratch following the instructions in the README.md 🆕

  • Add the code as per the README.md instructions 🧑‍💻

  • Get the project to the "Wow" moment of classifying an uploaded image 🤩

  • Speed run Fly.io deployment (don't focus on this part ...)

  • Transfer the captured screen recording to the Mac Mini for DaVinci Resolve Editing 🎬
    (happy to pair with you on this ...) using the speed editor/keyboard.

  • Edit the Video Tutorial to be as tight as possible (speed up any downloads) and

    • Add subtle/tasteful transitions 💄 between screens.
  • Publish the Tutorial to the @dwyl YT channel. 🚀

@nelsonic nelsonic added documentation Improvements or additions to documentation enhancement New feature or enhancement of existing functionality help wanted If you can help make progress with this issue, please comment! priority-1 Highest priority issue. This is costing us money every minute that passes. T1d Time Estimate 1 Day epic A feature idea that is large enough to require a sprint (5 days) or more and has smaller sub-issues. technical A technical issue that requires understanding of the code, infrastructure or dependencies labels Nov 21, 2023
@nelsonic nelsonic pinned this issue Nov 21, 2023
@nelsonic
Copy link
Member Author

nelsonic commented Feb 6, 2024

@LuchoTurtle when you feel the repo is “ready” for wider publication, please let’s get on a call and go through what is needed for recording the video with the highest possible production quality (image & sound).
forget about applying for jobs and doing pointless interview prep when there a thousand other candidates. Unless you personally know the hiring manager, the only way for them to GET to “know” you, your abilities/skills and communication is by recording a Video. It’s the reason people are required to submit a video as part of their application to YCombinator https://www.ycombinator.com/video.html or Founders & Coders.
once the video is published you share it on your LinkedIn and set your profile to “available for hire” and let the recruiters come to you!

@LuchoTurtle
Copy link
Member

Before tackling this issue, I need to get #18 sorted first and then change the frontend afterwards (haven't created an issue for this, will depend on how #18 is implemented). Only then I'll start recording a tutorial.

But #18 is quite a tall task to have it fully documented and tested. Though I feel it is close to being completed, there's testing that still needs to be done. Having semantic search will make this repo super duper useful imo :)

@nelsonic
Copy link
Member Author

nelsonic commented Feb 6, 2024

Audio-to-text (#18) was never the purpose of this repo.
It's an image classifier not a speech-to-text demo.
This is the definition of "feature creep".
Not saying that this isn't a nice-to-have feature, just definitely not something that we need.
I would much prefer to split the audio-to-text out into a separate repo to avoid complicating this one.
I should have made that clearer back in November... ⏳ 💭
I thought it was just going to be a "quick" addition. But it's really not ... 😕

Please completely ignore audio-to-text completely for the purposes of the Video Tutorial.
The audio-to-text should not be on the home page of this app.
It can be on a dedicated page as a separate demo. But it's not the focus.

Semantic search is useful, yes. But only if the person uploading an image doesn't get the desired classification.
The whole point of this project was to allow us to upload an image and have it classified. That's it.
Anything else is certainly a "bonus" but not the focus.

Avoiding recording the video because a nice-to-have non-core feature isn't done yet
is like people who procrastinate on fitness because they don't have the "right" water bottle. 🤦‍♂️

Just get the the video done for the "baseline" features so that the video is a brief as possible.
At the end of the video you can take 10 seconds to describe the "advanced" features (Semantic Search + Audio-to-Text)
and ask people if they want a follow-up video walking through them.

@github-project-automation github-project-automation bot moved this to More ToDo ThanCanEver Be Done in Nelson's List Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or enhancement of existing functionality epic A feature idea that is large enough to require a sprint (5 days) or more and has smaller sub-issues. help wanted If you can help make progress with this issue, please comment! priority-1 Highest priority issue. This is costing us money every minute that passes. T1d Time Estimate 1 Day technical A technical issue that requires understanding of the code, infrastructure or dependencies
Projects
Status: More ToDo ThanCanEver Be Done
Status: No status
Development

No branches or pull requests

2 participants