Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Embed Validating Models 101 playlist into Guides section#446

Merged
nrichers merged 5 commits intomainvalidmind/documentation:mainfrom
nrichers/sc-6631/re-record-validating-models-101-videosvalidmind/documentation:nrichers/sc-6631/re-record-validating-models-101-videosCopy head branch name to clipboard
Sep 26, 2024
Merged

Embed Validating Models 101 playlist into Guides section#446
nrichers merged 5 commits intomainvalidmind/documentation:mainfrom
nrichers/sc-6631/re-record-validating-models-101-videosvalidmind/documentation:nrichers/sc-6631/re-record-validating-models-101-videosCopy head branch name to clipboard

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Sep 25, 2024

Internal Notes for Reviewers

This PR embeds the playlist for "Validating Models 101" into our Guides landing page. This playlist includes five short videos, re-recorded with higher production quality, that cover:

  • Intro & quick tour for validators
  • Review model documentation
  • Analyze test results
  • Prepare validation report
  • Submit for review & approval

LIVE PREVIEW

image

External Release Notes

We created a series of short videos that introduce you to validating models on our platform. Watch the video series ...

@nrichers nrichers added the documentation Improvements or additions to documentation label Sep 25, 2024
@github-actions
Copy link
Contributor

PR Summary

This pull request introduces an enhancement to the model validation guide by embedding a YouTube video series iframe. The iframe provides a series of videos that can help users understand the model validation process better. The iframe is added just before the section on reviewing reports or exporting documentation for external records.

Test Suggestions

  • Verify that the YouTube video series iframe is correctly embedded and displays the video series as expected.
  • Check that the iframe does not break the layout of the page on different screen sizes and devices.
  • Ensure that the iframe's functionality (e.g., play, pause, fullscreen) works correctly across different browsers.
  • Test the page's loading performance to ensure that the iframe does not significantly impact it.
  • Verify that the referrer policy is correctly applied and that the iframe adheres to the specified security settings.

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Just making sure our videos follow the cleaned-up drop-shadow & rounded corner format here. Might be good to have some lead in text maybe?

site/guide/guides.qmd Outdated Show resolved Hide resolved
site/guide/guides.qmd Show resolved Hide resolved
nrichers and others added 2 commits September 25, 2024 15:18
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@nrichers
Copy link
Collaborator Author

@mehdi0501 did you want to take a look at this PR before we merge it before EOD Thursday?

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@nrichers
Copy link
Collaborator Author

@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.

@nrichers nrichers merged commit 084e7ab into main Sep 26, 2024
@nrichers nrichers deleted the nrichers/sc-6631/re-record-validating-models-101-videos branch September 26, 2024 23:16
nrichers added a commit that referenced this pull request Oct 3, 2024
* 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 <164545837+validbeck@users.noreply.github.com>

* 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 <johnwalz97@gmail.com>

---------

Co-authored-by: John Halz <johnwalz97@gmail.com>

* 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 <164545837+validbeck@users.noreply.github.com>

* Update site/guide/guides.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Undo lead-in text for video

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* 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 <164545837+validbeck@users.noreply.github.com>
Co-authored-by: John Halz <johnwalz97@gmail.com>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Morty Proxy This is a proxified and sanitized view of the page, visit original site.