Skip to content

Cleaned up Developer Fundamentals & other training #599

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

Merged

Conversation

validbeck
Copy link
Collaborator

@validbeck validbeck commented Dec 19, 2024

Internal Notes for Reviewers

sc-7476

Developer Fundamentals

LIVE PREVIEWREMINDER THAT THE NOTEBOOK EMBEDDED IN THE TRAINING IFRAME IS GOING TO PULL FROM THE ROOT OUTDATE DOCS-DEMO NOTEBOOK FOLDER AND NOT THE UPDATED PR FOLDER IN THE PREVIEW. PREVIEWING LOCALLY WILL NOT HAVE THE EXECUTION OUTPUT, BUT WILL BE MORE ACCURATE IN TERMS OF ANCHOR SECTIONS.

  • Added the Train a model section into PART 2
  • Split this course into 3 as with the additional section it's very long — added 10 minutes to the overall course time to accommodate these extra cells being run as well
  • The "1. Initializing the ValidMind Library" iframe was still linking to the old developer-framework anchor and therefore wasn't loading at the right place — fixed
Old New
Screenshot 2024-12-19 at 10 45 00 AM Screenshot 2024-12-19 at 10 51 22 AM
Screenshot 2024-12-19 at 10 45 42 AM Screenshot 2024-12-19 at 10 52 11 AM
Screenshot 2024-12-19 at 10 47 12 AM Screenshot 2024-12-19 at 10 54 23 AM
Screenshot 2024-12-19 at 10 47 35 AM Screenshot 2024-12-19 at 10 55 43 AMScreenshot 2024-12-19 at 10 55 51 AM
Screenshot 2024-12-19 at 10 47 56 AM Screenshot 2024-12-19 at 10 56 29 AM

Interactive iframes

I noticed that the anchored places on the executed notebook aren't set to background-interactive="true" — I infer this is purposeful, but it did feel like a bug when I was clicking around as a user for the frame to be locked. Food for thought.

Administrator Fundamentals

LIVE PREVIEW

I split this into 2 as there's actually a lot of info and IMO a topic-switch to more advanced setup near the end.

Old New
Screenshot 2024-12-19 at 10 45 03 AM Screenshot 2024-12-19 at 10 51 29 AM
Screenshot 2024-12-19 at 10 45 42 AM Screenshot 2024-12-19 at 10 58 06 AM
Screenshot 2024-12-19 at 10 48 32 AM Screenshot 2024-12-19 at 10 58 13 AM

Validator Fundamentals

LIVE PREVIEW

Same as above — I split this into 2 as there's actually a lot of info and IMO a topic-switch to a slightly different task near the end.

Old New
Screenshot 2024-12-19 at 10 45 07 AM Screenshot 2024-12-19 at 10 51 34 AM
Screenshot 2024-12-19 at 10 46 22 AM Screenshot 2024-12-19 at 10 57 02 AM
Screenshot 2024-12-19 at 10 48 56 AM Screenshot 2024-12-19 at 10 57 11 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Dec 19, 2024
@validbeck validbeck self-assigned this Dec 19, 2024
@validbeck validbeck requested a review from nrichers December 19, 2024 18:58
Copy link
Contributor

PR Summary

This pull request introduces structural and content enhancements to the training documentation for administrators, developers, and validators. The changes are aimed at improving the organization and clarity of the training materials by dividing the content into distinct parts and adjusting layout elements.

Key Changes:

  1. Administrator Fundamentals:

    • The content is now divided into two parts: Part 1 covers setting up the organization, onboarding users, and managing roles, permissions, and groups. Part 2 focuses on managing templates and workflows.
    • Adjustments to column widths for better visual balance.
  2. Developer Fundamentals:

    • The course content is reorganized into three parts: Part 1 includes initializing the developer framework and collaboration. Part 2 covers training a model and implementing custom tests. Part 3 involves viewing documentation activity and submitting for approval.
    • Duration of the course is updated from 90 to 100 minutes.
    • Adjustments to column widths for improved layout.
  3. Validator Fundamentals:

    • The content is split into two parts: Part 1 includes reviewing documentation, analyzing test results, and preparing validation reports. Part 2 covers tracking issue resolution and submitting for review and approval.
    • Adjustments to column widths for better presentation.

These changes aim to enhance the readability and usability of the training materials, making it easier for users to follow and understand the course content.

Test Suggestions

  • Verify that the new content structure is correctly displayed in the training documentation.
  • Check that all links within the documentation are functioning correctly.
  • Ensure that the updated course duration is reflected accurately in all relevant sections.
  • Test the visual layout on different screen sizes to ensure responsiveness.
  • Review the documentation for any broken images or incorrect background settings.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀🚀🚀

@validbeck validbeck merged commit c41ecd3 into main Dec 20, 2024
14 checks passed
@validbeck validbeck deleted the beck/sc-7476/developer-fundamentals-training-needs-a-better branch December 20, 2024 02:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants