A PR preview is available: Preview URL

A PR preview is available: Preview URL

PR Summary

This pull request introduces several enhancements and bug fixes to the ValidMind documentation and training templates. Key changes include:

1. New Course Templates: Added new course templates for Administrator Fundamentals, Developer Fundamentals, and Validator Fundamentals. These templates provide structured learning paths for different roles within the ValidMind platform.

   • Each course template includes sections for learning objectives, course content, and registration details.
   • The templates also include support and feedback mechanisms via Slack and email.

2. Documentation Updates: Updated various documentation files to improve clarity and consistency.

   • Replaced instances of "Select a model by clicking on it" with "Select a model or find your model by applying a filter or searching for it" for better user guidance.
   • Updated navigation links and file paths to reflect the new course structures.

3. Navigation and UI Enhancements: Modified the site navigation to include new training paths and updated links to reflect the new course structures.

   • Updated _quarto.yml to reflect changes in the training section.
   • Adjusted iframe links in index.qmd to point to the new course pages.

4. Issue Tracking for Validation: Added a new section for tracking issue resolution in the validation process.

   • This includes guidance on assessing open issues and determining the severity of findings.

These changes aim to enhance the user experience by providing clearer guidance and structured learning paths for different user roles.

Test Suggestions

• Verify that all new course templates render correctly and include all necessary sections.
• Test the registration and support links in the new course templates to ensure they direct users to the correct resources.
• Check that the updated navigation links in _quarto.yml reflect the new course structures and are functional.
• Ensure that the updated phrasing in documentation files improves clarity and does not introduce any navigation issues.
• Test the issue tracking section in the validation process to ensure it provides accurate guidance on assessing and resolving findings.

A PR preview is available: Preview URL

A PR preview is available: Preview URL

A PR preview is available: Preview URL

• I don't like that all of the images are the same. I think this doesn't add anything.

Let's chat at our community standup. I agree that having the same images be the same is also not great but it feels like a lesser evil. I did actually look into whether the tiles for listing pages could embed live content, but I'm not sure it's easy. Maybe there is some middle ground — e.g. I could even just use screenshots of the training title pages.

• I also don't like that we use the .html links in the iframes for the previews... again, complex code for no reason.

Related to the complexity introduced by the HTML code, agreed. I ran out of time on making improvements, but let me spend a bit of time this afternoon to create a new class for this.

• I also don't like that we use the .html links in the iframes for the previews... again, complex code for no reason.

Related to the complexity introduced by the HTML code, agreed. I ran out of time on making improvements, but let me spend a bit of time this afternoon to create a new class for this.

I solved this issue. We now have a new extension via da2ed0e that allows you to use course-preview with .qmd files, e.g.

::: {.course-preview src="validator-fundamentals.qmd"}
:::

Style guide info coming shortly ...

EDIT: This renders as follows, which actually works better than the iframe HTML we had before because I was able to omit the pink band at the bottom.

A PR preview is available: Preview URL

A PR preview is available: Preview URL

A PR preview is available: Preview URL

A PR preview is available: Preview URL

A PR preview is available: Preview URL

I strongly prefer if we revert to the original graphics or the preview for the courses and will push a commit to that effect.

• I don't like that all of the images are the same. I think this doesn't add anything.

If my extension for course previews was decidedly more clever, my solution for this issue is rather low tech: For now, I have added images of the title page for each course.

There's very likely a better way to handle this but I'm out of time on this PR. In the future, we might look into a more bespoke listing tile we can create that also shows the live preview or automatically generate images from an URL.

A PR preview is available: Preview URL

If my extension for course previews were a bit more clever ...

I spent some time over the weekend thinking about this. I think the future of this extension lies in creating a more flexible version of the listing page tiles we've been using, which have some quirks we've been working around. I envision updating this extension to:

• Preview any relevant page based on context, such as our upcoming interactive tech demo on the front page
• Preview specific sections from a page or render code cells in real time, surfacing parts of an interactive notebook
• Integrate the chatbot MVP cleanly on the front page or any other page without resorting to low-level page modifications
• Use one page as a teaser (e.g., a training module) but link to another (e.g., the registration page)

This morning, I’ll spend an hour reworking the extension to make it a bit more generic in name (page-preview preview comes to mind) and will document the rest for the future in a story. For now, this extension shows that we can extend Quarto quickly and effectively.

A PR preview is available: Preview URL

A PR preview is available: Preview URL

A PR preview is available: Preview URL

Nice!!

The only thing is, why is Administrator Fundamentals in two rows? Strange...

EDIT: Oh I see, for some reason the file itself has a <br> in the title... 🤔