Skip to content

feat(#3511): add links to old v1 docs#3565

Merged
chrisolsen merged 1 commit into
devfrom
benji/3511
Mar 30, 2026
Merged

feat(#3511): add links to old v1 docs#3565
chrisolsen merged 1 commit into
devfrom
benji/3511

Conversation

@bdfranck
Copy link
Copy Markdown
Collaborator

@bdfranck bdfranck commented Mar 12, 2026

This PR prepares our DS 2 docs for links from DS 1 docs with the following changes...

  • Adds DS 1 docs links to the bottom of individual component and example pages
  • Adds redirects from DS 1 docs URLs including...
    • Components with different paths (ex: /components/circular-progress-indicator ➡️ /components/circular-progress)
image image

The related DS 1 docs changes: GovAlta/ui-components-docs#484

@bdfranck bdfranck marked this pull request as ready for review March 12, 2026 22:54
Copy link
Copy Markdown
Collaborator

@twjeffery twjeffery left a comment

Choose a reason for hiding this comment

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

@bdfranck Looks good to me, other than the URLs not resolving yet, as we're waiting for #3510 as discussed.

Should we wait to merge this until #3510 issue is done?

@bdfranck
Copy link
Copy Markdown
Collaborator Author

I'll move this back to draft as we wait for #3510.

@bdfranck bdfranck marked this pull request as draft March 18, 2026 16:19
@Spark450 Spark450 added the P1 Priority 1 (must have): Prevents product teams from adopting/using DS 2.0 as intended at launch. label Mar 19, 2026
@bdfranck
Copy link
Copy Markdown
Collaborator Author

I rebased against dev and tested the changes.

When I am viewing a component in the v2 docs,
And I scroll to the bottom and select the v1 docs link,
I can see the v1 docs.

nav-to-component-test.mp4

When I am viewing an example in the v2 docs,
And I scroll to the bottom and select the v1 docs link,
I can see the v1 docs.

nav-to-example-test.mp4

@bdfranck bdfranck requested a review from twjeffery March 27, 2026 20:16
@bdfranck bdfranck marked this pull request as ready for review March 27, 2026 20:21
Copy link
Copy Markdown
Collaborator

@twjeffery twjeffery left a comment

Choose a reason for hiding this comment

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

@bdfranck I noticed the v1 links use the DS 2 slug for all components. For the ones that were renamed, the link lands on "Coming Soon!" on the v1 site. I tested these 8 locally:

  1. circular-progress (v1: circular-progress-indicator)
  2. file-upload-input (v1: file-uploader)
  3. app-header (v1: header)
  4. icon (v1: icons)
  5. linear-progress (v1: linear-progress-indicator)
  6. notification (v1: notification-banner)
  7. radio-group (v1: radio)
  8. skeleton (v1: skeleton-loader)
Image

The redirect config already has this mapping, just in the other direction. We could add a reverse lookup so the v1 link uses the right slug.

Also, the v1 link is inside the Properties tab, so it's not visible from the other tabs. We could move it outside of the tabs?

@bdfranck
Copy link
Copy Markdown
Collaborator Author

@twjeffery Yes, I've addressed the redirects in the related v1 docs PR. You can see them here:

https://github.com/GovAlta/ui-components-docs/pull/484/changes#diff-d267d14e50f20b22c6ee8d6f5977a78fcffab68ba01e92dab42e67637128675a

I've moved the link out of the tab, rebased against the latest dev, and resolved the merge conflicts.

@bdfranck bdfranck requested a review from twjeffery March 30, 2026 21:01
@chrisolsen chrisolsen merged commit c8c4680 into dev Mar 30, 2026
3 of 4 checks passed
@chrisolsen chrisolsen deleted the benji/3511 branch March 30, 2026 21:19
@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0-dev.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0-dev.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 7.0.0-dev.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 5.0.0-dev.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 7.0.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 5.0.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen chrisolsen added the released Released into production. label Mar 31, 2026
@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 7.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@chrisolsen
Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 5.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

P1 Priority 1 (must have): Prevents product teams from adopting/using DS 2.0 as intended at launch. released on @dev released on @next released Released into production.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Design and build cross-version navigation between DS 1.0 and DS 2.0 docs

4 participants