Embed "How do I ... add tests?" video in developer docs#450
Conversation
PR SummaryThis pull request introduces an enhancement to the Changes:
Test Suggestions
|
validbeck
left a comment
There was a problem hiding this comment.
Again, I'm not a fan of NOT having lead-in text to videos. It should be clear what the content of the videos are and what value they bring that supplements or differs from the written docs.
Before I go ahead and add lead-in text to address your concerns, let me explain why I think it isn't necessary here:
Finally, lead-in text had a storied life before becoming passé around 2010. At one point, our editors required it for many things at IBM, for instance, you couldn't have a heading followed immediately by a list without lead-in text. Then, one year, a revolution happened, and writing minimalism replaced many of those guidelines almost overnight. If the context was clear, the new guidance was to omit lead-in text. (And then IBM decided it didn't need editors, either, but that's a separate story.) That said, if I still haven't convinced you, I'll add some lead-in text. 🙂 |
|
A PR preview is available: Preview URL |
|
Thank you for the explanation as to your logic! I think the video titles are more vague to me than they are to you, so that's where we disagree. I don't think it "makes or breaks" things, and if the interest is lightness, then that's fine with me — just letting you know that personally as a user, I'm not inclined to click on videos unless there's some explanation as to why I should spend my time watching it. |
|
Ah, I see what it is my brain is flagging.
The Can we at least retitle the video filename on YouTube to just "How do I add tests?" |
Yes, and that's very good feedback! Maybe a good middle ground would be to require meaningful video titles that are easy to parse. I can also do one better and expand the video title a bit: 
Would this work for you for now? |
|
@mehdi0501 I'm going to merge this, but if you have feedback, please open a story or let me know what the feedback is and I will open a story to make sure it's addressed. |
* Fix staging deploy in Makefile (#428) * Simplify merge strategy for staging (#373) * Simplify merge strategy * Minor workflow tweaks * Switch to test branches * Add comment to trigger workflow * Add comment to trigger workflow * Add comment to trigger workflow * Switch to squash merge * Add comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Try --ff strategy * Add test comment to trigger workflow * Add test comment to trigger workflow * Revert to --no-ff strategy * Try reset --hard * Switch to --merge for PRs * Switch back to merge --no-ff * Try merge --ff again * Add test comment to trigger workflow * Switch back to merge --no-ff * Add test comment to trigger workflow * Switch back to squash merging for PRs * Add test comment to trigger workflow * Remove test comments * Revert to --merge for PRs * Testing PR#373 - push to branch from local * Add comment to trigger workflow * Add comment to trigger workflow * Add comment to trigger workflow * Switch to squash merge * Add comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Remove comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Add test comment to trigger workflow * Switch to --merge for PRs * Add test comment to trigger workflow * Add test comment to trigger workflow * Switch back to squash merging for PRs * Add test comment to trigger workflow * Remove test comments * Revert to --merge for PRs * Undo test changes * Undo test comment --------- Co-authored-by: Beck <[email protected]> * I'm dumb (#431) * Fix branch in merge-main-into-staging.yaml (#432) * Styled screenshots & cleaned up current screenshots (#420) * Added a .screenshot CSS class * Sample image * Changed class for About -releases * Changed class for Get Started & edited images to be uniform * Changed class for guides/configuration * Changed class for guides/model-workflows * Changed class for guides/model-inventory * Changed class for guides/model-documentation * Changed class for guides/model-validation * Changed class for guides/monitoring * Changed class for developer/ * Changed class for releases/ 1st pass * Cropped images for 2024-may-22 -1 gif * Reverting changes for a gif to crop again * Cropped images for releases 2nd pass * Cropped images for releases 3rd pass * Cropped images for releases 4th pass * More tweaks * Videos styling * Tweaks to JH quickstart * More cropping * Applied class to training * Annotated screenshots in guides/ * Currency field type (#423) * Preview of Generate with AI docs sections (#419) * Preview of Generate with AI docs sections * Release notes draft * Image edits * Editing release * Release notes done * Final tweaks + new gif * Oops I lied * anchor links * Added attachment field type (#442) * Added attachment field type * Wording tweak * Missed one * Pulling in latest from developer-framework PR#195 (#438) * Pulling in latest from developer-framework * Added .screenshot class to model inventory fields * Added aliases for index.html & training-overview.html (#444) * Docs: Work with metrics over time (#449) * WIP * Key concepts draft * Clarified monitoring instructions now w/ accurate default permissions * Final draft of Work with metrics over time * Adjusted Work with content blocks * Fixing display issue for test description listings on monitoring * Update site/guide/monitoring/work-with-metrics-over-time.qmd Co-authored-by: John Halz <[email protected]> --------- Co-authored-by: John Halz <[email protected]> * Templates for videos (#415) * Add docs.validmind.ai/training redirect * Update backgrounds, remove slide numbering, add slide links * Add initial presentation with sample intro slides * Add slides * Update video slides * Hide controls * Organize slides into sections by type * Minor update for adding tests * Calculation field instructions & example (#443) * Calculation field instructions & example * Tweak * Moved calculation screenshot into its own line * Added Juan's magic formula * Set up backfilled redirects for renamed pages (#454) * 1st pass of links that used to be on developer-framework * 1st pass of other external links to docs * 1st pass of newer renames * Big restructure of guides alias links 1st pass * Restructure of Documenting models 1st pass * 2nd pass of big restructure * Final pass of big restructure * Added alias redirects to style guide * Embed Validating Models 101 playlist into Guides section (#446) * Embed Validating Models 101 playlist into Guides section * Remove whitespace * Update site/guide/guides.qmd Co-authored-by: Beck <[email protected]> * Update site/guide/guides.qmd Co-authored-by: Beck <[email protected]> * Undo lead-in text for video --------- Co-authored-by: Beck <[email protected]> * Embed "How do I ... add tests?" video in developer docs (#450) * Add how do I add test video * Switch to iframe for video embed --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Beck <[email protected]> Co-authored-by: John Halz <[email protected]>
Internal Notes for Reviewers
This PR adds a new "How do I ... add tests?" FAQ-style video to our developer content. This is a single, short FAQ-style video that answers a specific question. This one covers:
LIVE PREVIEW
Note this video embed does not include lead-in text. Some had been added to #446 but I removed it again for the sake of simplicity.
(Related, I am not clear on what alt tests we might need to provide for videos. YouTube does generate captions but it's something to look into.)
External Release Notes
We added a short FAQ-style video to our developer documentation that shows you how to find tests ValidMind provides and add them to your own model documentation. Watch it ...