Skip to content

Set up backfilled redirects for renamed pages #454

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 Sep 26, 2024

Internal Notes for Reviewers

sc-6755

For any pages that were moved or renamed since we started restructuring our docs site to be more organized, I added an alias to the page that replaced it.

This included any files that did NOT have the search: false but were not complete, so at some point they were discoverable by users. I just redirected them to the page that made the most sense.

Pages deleted

internal/templates/page-moved.qmd

Added this callout to the "Filenames" section in the style guide as I removed the old page-moved.qmd template:

Screenshot 2024-09-26 at 4 07 55 PM

site/developer/model-documentation/generate-model-documentation.qmd & site/developer/model-documentation/generating-model-documentation.qmd

These were dupes retained by GH's merging logic, probably. They have been replaced by "Documenting models" section so I just redirected people there in case they have an old link:

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

PR Summary

This pull request introduces several enhancements and cleanups to the documentation site:

  1. Aliases for Redirects: Added aliases to multiple .qmd files to ensure that users are redirected to the correct pages if the URLs have changed. This helps maintain backward compatibility and improves user experience by preventing broken links.
  2. Removal of Deprecated Pages: Removed outdated or redundant .qmd files that are no longer needed. This helps in maintaining a clean and up-to-date documentation repository.
  3. Documentation Enhancements: Added important callouts and examples in the style guide to guide users on how to use Quarto aliases for redirecting users to new pages when files are moved or renamed.
  4. Footnote Updates: Updated footnote references in the style guide to ensure they point to the correct resources.

Test Suggestions

  • Verify that all added aliases correctly redirect to the intended pages.
  • Check for any broken links in the documentation site after the changes.
  • Ensure that the removed pages are no longer accessible and do not cause any 404 errors.
  • Test the functionality of the callouts and examples added to the style guide.
  • Run a full site build to ensure there are no build errors or warnings related to the 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 🚀

@validbeck validbeck merged commit c8c8bc5 into main Sep 26, 2024
6 checks passed
@validbeck validbeck deleted the beck/sc-6755/set-up-backfilled-redirects-for-renamed-pages branch September 26, 2024 23:15
nrichers added a commit that referenced this pull request Oct 3, 2024
* 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
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