Skip to content

Training course templates & organizational refinement#509

Merged
validbeck merged 14 commits intomainfrom
beck/sc-7323/training-course-admin-work
Nov 6, 2024
Merged

Training course templates & organizational refinement#509
validbeck merged 14 commits intomainfrom
beck/sc-7323/training-course-admin-work

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Nov 5, 2024

Internal Notes for Reviewers

sc-7323

Course folder renames

Old New
administrator administrator-fundamentals
developer developer-fundamentals
validator validator-fundamentals
wip risk-governance-fundamentals

Training templates

There's now a new training-templates folder that lives within the /training directory instead of living outside in the main /templates/internal directory. These pages are set to search: false.

  • course-registrationserves as a basic template for registration/course outline pages: LIVE PREVIEW
  • course-slides.qmd captures our commonly used slide styles in a live demo (and why I moved them out of the internal into the site): LIVE PREVIEW 🎉

Style guide rework

Screenshot 2024-11-05 at 1 50 21 PM

There was a random preview section that wasn't nested under the training materials, so I've just stolen some of the content from that and reworked the "Training" section:

LIVE PREVIEW

Other edits

Screenshot 2024-11-05 at 1 51 31 PM
  • Trying out "ValidMind Academy" for the training section, since it's its own neat semi-separate portal now to align with how we talk about it in the rest of the site.
  • custom.scss > slides.scss to match our style guide rule of filenames should reflect what they're for.
  • There were some html centers hanging around in the training slides and some awkward lead-in text; I've fixed those.

Video templates?

These are still using the old slide sliding/site theme. I left them untouched as I don't know if we wanted to update these, given that videos are being filmed as we speak...

@validbeck validbeck added the internal Not to be externalized in the release notes label Nov 5, 2024
@validbeck validbeck self-assigned this Nov 5, 2024
@validbeck validbeck requested a review from nrichers November 5, 2024 21:53
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 5, 2024

PR Summary

This pull request introduces several changes to the structure and content of the training modules within the ValidMind documentation. The key changes include:

  1. Removal of Obsolete Files: The fundamentals.qmd file has been removed, indicating a possible restructuring or consolidation of training materials.

  2. Path Updates: Paths in the _quarto.yml configuration file and other related files have been updated to reflect a new directory structure for training modules. This includes changes from paths like training/administrator/administrator-fundamentals-register.qmd to training/administrator-fundamentals/administrator-fundamentals-register.qmd.

  3. Style Guide Enhancements: The style guide has been updated to provide clearer instructions on embedding course previews and using CSS for training slides. This includes the addition of new sections and examples for course registration and slide styling.

  4. Template and Style Updates: New templates for course registration and slides have been added, such as course-registration.qmd and course-slides.qmd. These templates include updated CSS references and layout improvements.

  5. Image and Asset Management: New images and assets have been added to support the updated training modules, such as administrator-fundamentals.png, developer-fundamentals.png, and validator-fundamentals.png.

  6. Content Adjustments: Minor content adjustments have been made across various files to improve clarity and consistency, such as updating login instructions and slide themes.

Overall, these changes aim to enhance the organization, accessibility, and presentation of the training materials within the ValidMind documentation.

Test Suggestions

  • Verify that all updated paths in _quarto.yml and other configuration files correctly point to the new locations of training modules.
  • Test the rendering of the new course registration and slide templates to ensure they display correctly with the updated CSS.
  • Check that all links within the training modules, especially those related to login and course navigation, are functional.
  • Ensure that the removal of fundamentals.qmd does not break any existing references or functionality.
  • Validate that the new images and assets are correctly linked and displayed in the documentation.

Copy link
Copy Markdown
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! (Looks GREAT to me). 🚀 You continue to make all of these incremental improvements to our site that add up to a far nicer look & feel. The new template for training content is a nice touch and will come in very useful — I might even co-opt it for part of our tech demo.

@validbeck
Copy link
Copy Markdown
Collaborator Author

@nrichers

I simplified the styles for the default listings so that they display like this everywhere but training (the training will universally have the green styled table as long as the page is calling from training.css):

Screenshot 2024-11-05 at 4 56 52 PM

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

1 similar comment
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Nov 6, 2024

A PR preview is available: Preview URL

@validbeck validbeck merged commit 74988c9 into main Nov 6, 2024
@validbeck validbeck deleted the beck/sc-7323/training-course-admin-work branch November 6, 2024 01:28
@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented Nov 6, 2024

I simplified the styles for the default listings so that they display like this everywhere but training (the training will universally have the green styled table as long as the page is calling from training.css):

Very nice! This simplified style seems to work well.

For the external URLs you use in your example, I currently use the .preview extension but we can perhaps chat tomorrow about what makes the most sense.

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