Skip to content

Make training slides more photogenic #412

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 20, 2024
Merged

Make training slides more photogenic #412

merged 2 commits into from
Sep 20, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Sep 19, 2024 •
edited
Loading

Internal Notes for Reviewers

This PR makes our training slides more suitable for standalone how-to videos and adds some other usability tweaks.

Live Preview

Added the new hero banner background from validmind.com in the title slide — also added a reference to our main training URL and removed the short-lived laurels.

Before After
image image

Removed numbering from section slides and added the same background — the numbering looked off in standalone recordings when a video started on one of these section title pages; you can now basically start a video on any of these slides for the intro.

Before After
image image

Added links to training module sections in overview pages — these likely should have been there all along, and now they exist.

Before After
image image

Usability tweaks — stuff I discovered while shooting footage.

External Release Notes

We updated our training modules to use ValidMind's new color scheme and to make them easier to use. Sections in the training modules are now linked to from the training overview and a new URL for our training content makes it easier to find: docs.validmind.ai/training

@nrichers nrichers added the documentation Improvements or additions to documentation label Sep 19, 2024
@nrichers nrichers changed the title Make training slides photogenic Make training slides more photogenic Sep 19, 2024
@nrichers nrichers requested a review from validbeck September 19, 2024 21:50
@github-actions GitHub Actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the training documentation and styling for the ValidMind project. The key changes include:

  1. Styling Updates:

    • Added new CSS rules in custom.scss to ensure links in sections with dark backgrounds are displayed in white for better visibility.

  2. Training Documentation Enhancements:

    • Updated the subtitle in multiple training .qmd files to include a link to docs.validmind.ai/training.
    • Changed the background color and image for title slides in training documents to improve visual consistency and branding.
    • Converted plain text list items to links in the training documents to enhance navigation.
    • Added background color and image attributes to various section headers to maintain a consistent look and feel.
    • Added an alias to the main training page (training.qmd) for better URL management.

These changes aim to improve the user experience by enhancing the visual appeal and navigability of the training materials.

Test Suggestions

  • Verify that links in sections with dark backgrounds are displayed in white and are readable.
  • Check that the updated subtitle with the link to docs.validmind.ai/training is correctly rendered in all training documents.
  • Ensure that the new background color and image are applied to the title slides in all training documents.
  • Test the navigation links in the training documents to ensure they correctly navigate to the intended sections.
  • Confirm that the alias for the main training page (training.qmd) works as expected and redirects appropriately.

validbeck
validbeck approved these changes Sep 19, 2024
View reviewed changes
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.

I love the new skin!

Added links to training module sections in overview pages — these likely should have been there all along, and now they exist.

This was removed because the "back" button doesn't take you to the landing page, but to the page prior to whatever anchor it led you to.

@nrichers
Copy link
Collaborator Author

This was removed because the "back" button doesn't take you to the landing page, but to the page prior to whatever anchor it led you to.

I'll wait with merging until we can chat about this, but when I tested all the links, clicking on a link takes you to that page and clicking the back button, well, takes you back. I suspect I'm confused about what the issue is, hence the wait.

@nrichers
Copy link
Collaborator Author

This was removed because the "back" button doesn't take you to the landing page, but to the page prior to whatever anchor it led you to.

No change required here — you reminded me that we have different expectations for what the < on slides should do if you arrive on a page by way of a link (you: take me back to the slide I came from; me: go back one slide, regardless of where I cam from).

For now, I would prefer that we not remove the links from the overview page as they make training easier to navigate.

@nrichers nrichers merged commit d84eae3 into main Sep 20, 2024
11 of 24 checks passed
@nrichers nrichers deleted the make-training-slides-photogenic branch September 20, 2024 01:36
@validbeck validbeck mentioned this pull request Sep 20, 2024
Merged
nrichers added a commit that referenced this pull request Sep 21, 2024
@nrichers
Make training slides more photogenic (#412)
d4324fc 
* Add docs.validmind.ai/training redirect

* Update backgrounds, remove slide numbering, add slide links
nrichers added a commit that referenced this pull request Sep 21, 2024
@nrichers @github-actions @validbeck
Fix merge conflicts in prod for Sep 20, take 2 (#427)
e267861 
* Add staging docs site deploy and update prod deploy (#309)

* Add new staging docs site deploy action and workflow

* Change to PR branch for testing

* Change to PR branch for testing, take 2

* Add quarto render steps to staging and prod workflows

* Minor wording fix

* Minor wording tweaks

* Change to prod site for testing

* Fix path issue in aws command, revert to correct branches

* Remove some GitHub variables

* Switch staging deploy to new AWS access keys

* Switch to PR branch for testing

* Fix duplicate names

* Update bucket region info

* Formatting

* Update Cloudfront info for staging and debug paths

* More path debugging

* More path debugging

* Fix deploy paths & remove debugging info

* Switch back to staging branch

* Change to PR branch for testing

* Change back to staging branch

* Change to PR branch and docs-demo bucket for testing

* Change back to prod branch and prod bucket

* Delete site/_site directory in staging (#326)

* Revamped Model Activity docs (#315)

* Filter activity setup

* Simplified some inline links

* Draft of edited unless-format footnotes

* Edited unless-format for Model Activity & Document Overview

* Edited unless-format for Submit for approval

* Edited unless-format for Assess compliance

* Edited unless-format for Work with model findings

* Fixed broken links in single-source

* Edits based on what is available locally

* Final tweaks

* Added single-source template

* Update README.md

* Update README.md

* Update site/guide/configuration/manage-your-profile.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/configuration/manage-your-profile.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Bolded compliance assessments

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Release notes for Sept 9 2024 (#329)

* Draft of new release notes

* Edited validation guidelines release

* Draft -need to edit bug fixes

* Why did it not commit all files??

* Final tweaks to body

* Summary added

* Grammar??

* Removed extra documentation as requested

* Removed bug fixes

* My brain is not on today, typo

* Only running the PR previews bot when a PR is ready for review (#330)

* Can we make it only run once let's see

* Updated to review_requested

* Modify make python-docs to support rendering online (#336)

* Modify make python-docs to store files in site folder

* Add python-docs to source

* Delete .github/workflows/render-site.yaml (#344)

* Investigate listing page issue  (#334)

* Remove echoing to log file

* Add quarto check to workflow

* Add TinyTex install

* Experiment by removing tabset

* Remove TinyTex install

* Re-add tabset, try individual file embeds

* Try changing wildcard embed

* Try different wildcard embed

* Undo workflow changes

* Fix Heap embeds for docs sites — `main` branch (#339)

* Remove production Heap embed

* Re-add Heap file for development

* Fix heap embeds for docs sites — staging branch (#340)

* Doc: Archive and delete inventory models (#351)

* Delete model findings draft

* Tweaks to project > model

* Draft for Archive & delete models

* Oops carried changes from a working branch instead of main, reverting

* Tweaking wording

* Indecisive about wording today

* Added archive & delete to sidebar

* Final tweaks based on what's on staging

* Typo

* Tired, tweaks

* Update site/guide/model-inventory/archive-delete-models.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Revamped model findings docs for attachments (#352)

* Draft

* More fiddling

* Fiddling

* Link tweaks

* More project tweaks

* Editing based on demo

* Created new Working with model findings landing

* 1st pass of broken links

* 2nd pass of broken links

* Summary drafts

* Tweaks

* More tweaks

* Adjustments for prod

* Adding deletion after discussion

* Images

* Removed commented out indications for required fields

* New all model findings image

* Pulling in latest changes from PR184 (#350)

* Pulled in latest test descriptions Sept 03 2024

* Example retrieval for process docs

* Delete finding docs update (#355)

* Delete finding update, also python docs from main?

* Changed to Add and manage model findings

* Moved activity to model inventory & adjusted pages (#358)

* Moved activity to model inventory & adjusted pages

* Missed a link apparently thanks workflow

* Missed an external link

* Training updates related to creating videos (#227)

* Update training title slides

* Move training into navbar

* Fix glossary entry

* Rename training overview file

* Fix links to old training filename

* Minor styling tweaks before recording videos

* Add instruction to verify workflow

* Clean up

* Update title

* Comment out banner

* Re-added announcement, but for our technical brief

* lil divider for funsies

---------

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

* Clarified style guidelines for links & training (#363)

* Inline link & training draft

* Edits to footnotes

* Example images

* Footnotes

* Tweaks

* Typos

* Update site/about/contributing/style-guide/conventions.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Edited the other front matter ref

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Adding new ValidMind colors & logo (#366)

* Start adding updated ValidMind colors & logo

* Bit more of that lovely green

* Prereq tweak

---------

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

* Update workflows to trigger on workflow_run (#368)

* Update workflows to enable workflow_run

* Experiment with workflow_dispatch

* Update README.md (#369)

* Use Quarto profiles for rendering the site on GitHub and locally (#372)

* Move Heap info its own environment folder

* Add Quarto profiles

* Add profiles for more development builds

* Docs site audit accuracy tone review — Guides p1 (#377)

* Edits to swap docs templates

* Added ongoing monitoring to swap templates

* Cleaned up guides.qmd

* Cleaned up log-in-to-validmind.qmd

* Cleaned up set-up-your-organization.qmd

* Cleaned up configure-google... .qmd

* Cleaned up managing-users .qmd

* Cleaned up manage-users.qmd

* Cleaned up manage-groups.qmd

* Cleaned up manage-roles.qmd

* Cleaned up manage-your-profile.qmd

* Cleaned up customize-your-dashboard.qmd

* Cleaned up working-with-model-workflows.qmd

* Cleaned up customize-model-lifecycle-statuses.qmd

* Cleaned up set-up-model-workflows.qmd

* Cleaned up working-with-model-inventory.qmd

* Cleaned up register-models-in-inventory.qmd

* Cleaned up customize-model-inventory-layout.qmd

* Cleaned up edit-model-inventory-fields.qmd

* Cleaned up view-model-activity.qmd

* Cleaned up configure-model-interdependencies.qmd

* Cleaned up manage-model-inventory-fields.qmd

* Tweaks for model stage columns

* Cleaned up view-documentation-templates.qmd

* Cleaned up customize-documentation-templates.qmd

* Cleaned up swap-documentation-templates.qmd

* Cleaned up assign-documentation-section-statuses.qmd

* Cleaned up submit-for-approval.qmd

* Cleaned up export-documentation.qmd

* Cleaned up collaborate-with-others.qmd

* Project > Model updates

* Cleaned up manage-validation-guidelines.qmd

* Cleaned up pereparing-validation-reports.qmd

* Cleaned up review-model-documentation.qmd

* Cleaned up assess-compliance.qmd

* Cleaned enable-monitoring.qmd

* Cleaned review-monitoring-results.qmd

* Final tweaks

* Captions added to configuration/

* Captions added to model-workflows/

* Captions added to model-inventory/

* Captions added to model-documentation/

* Captions added to model-validation/

* Captions added to monitoring/

* Update site/guide/configuration/configure-aws-privatelink.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/model-documentation/collaborate-with-others.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Quick tweak

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Revamped View reports (#409)

* Draft edits

* New images

* Setup for overview of data

* Final revamp, +customizing model findings view

* Final tweaks

* Update site/guide/model-validation/view-filter-model-findings.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Adjusted casing for report widgets

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

* Updated Work with content blocks (#390)

* Draft of metric over time blocks info

* Draft for toolbar overview

* Adjusting images

* Edits for toolbar

* Quick tweak

* Quick single source

* Make training slides more photogenic (#412)

* Add docs.validmind.ai/training redirect

* Update backgrounds, remove slide numbering, add slide links

* Documented user registration process (#410)

* Draft new pages

* New files

* Draft for independent signup

* Last save for the day

* Simplifying some stuff

* Accept invitation draft

* Layout tweaks

* Accept invite wip

* Register done for now

* New registration variable

* Applied new variable across site

* Final tweaks

* Quick tweak

* Cropped images

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>

* Tweaks

---------

Co-authored-by: Nik Richers <nik@validmind.ai>

---------

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@validbeck validbeck validbeck approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nrichers @validbeck