Skip to content

Added new aliases to training.qmd #444

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
validbeck merged 1 commit into from
Sep 25, 2024
Merged

Added new aliases to training.qmd #444

validbeck merged 1 commit into from
Sep 25, 2024

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Sep 24, 2024 •
edited
Loading

Internal Notes for Reviewers

sc-6684

I added two new aliases to training.qmd:

  • index.html
  • training-overview.html

I tested these redirects locally and they work! Neat Quarto feature, we can probably use the alias tool for some of our other renamed docs as well just for fallback's sake.

Live tests

@validbeck validbeck added the internal Not to be externalized in the release notes label Sep 24, 2024
@validbeck validbeck self-assigned this Sep 24, 2024
@validbeck validbeck requested a review from nrichers September 24, 2024 22:25
@github-actions
Copy link
Contributor

github-actions bot commented Sep 24, 2024

PR Summary

This pull request updates various references to the training file from training.qmd to index.qmd across multiple documentation files. The changes ensure that all links and references point to the correct training index file, improving navigation and consistency within the documentation.

Key Changes:

  • Updated navigation links in site/_quarto.yml to point to training/index.qmd instead of training/training.qmd.
  • Modified references in site/releases/2024-may-22/release-notes.qmd to link to training/index.qmd.
  • Added new aliases in site/training/index.qmd for better URL handling.
  • Updated footer and onboarding links in various training modules (training-for-administrators.qmd, training-for-model-developers.qmd, training-for-model-risk-governance.qmd, training-for-model-validators.qmd) to reference index.qmd.

These changes are aimed at improving the user experience by ensuring all training-related links are consistent and correctly directed.

Test Suggestions

  • Verify that all links in the navigation menu correctly point to training/index.qmd.
  • Check that the links in the release notes (site/releases/2024-may-22/release-notes.qmd) correctly navigate to training/index.qmd.
  • Ensure that the new aliases in site/training/index.qmd work as expected and redirect appropriately.
  • Test the footer links in all training modules to confirm they point to index.qmd.
  • Validate that the onboarding links in the training modules correctly navigate to the index.qmd#onboarding section.

@validbeck validbeck force-pushed the beck/sc-6684/create-redirect-for-docs-validmind-ai-training branch from ec5fec1 to 477e7d2 Compare September 24, 2024 23:34
@validbeck validbeck changed the title Created new training/index.qmd and added aliases Added new aliases to training.qmd Sep 24, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Sep 24, 2024

A PR preview is available: Preview URL

nrichers
nrichers requested changes Sep 25, 2024
View reviewed changes
Copy link
Collaborator

@nrichers nrichers left a comment •
edited
Loading

Choose a reason for hiding this comment

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

One change that needs to be made, LGTM otherwise.

EDIT: Please ignore this request, will approve.

nrichers
nrichers approved these changes Sep 25, 2024
View reviewed changes
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! 🚀

(Please ignore my earlier request — I tested in the preview and we do need index.html in the training path.)

@validbeck validbeck merged commit 4e2926b into main Sep 25, 2024
@validbeck validbeck deleted the beck/sc-6684/create-redirect-for-docs-validmind-ai-training branch September 25, 2024 17:59
nrichers added a commit that referenced this pull request Oct 3, 2024
@nrichers @github-actions
@validbeck @johnwalz97
Merge staging into prod (#462)
fcadf24 
* 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

Reviewers

@nrichers nrichers nrichers approved these changes

Assignees

@validbeck validbeck

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@validbeck @nrichers