Skip to content
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

UI: Add links to documentation and videos in UI #25565

Merged
merged 20 commits into from
Jan 19, 2024
Merged

Conversation

ShaunEvening
Copy link
Contributor

@ShaunEvening ShaunEvening commented Jan 11, 2024

What I did

  • Add API function to get the versioned docs URL
  • Add versioned link to docs into the sidebar menu
  • Fix missing icons in sidebar menu
  • Attach Storybook renderer to docs links
  • Add education links to empty state of interaction tests panel
  • Match icons across empty states

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a sandbox for any template
  2. Open in browser
  3. Check that docs link in menu goes to 8.0 docs
  4. Go to example-page--logged-out to see the empty interactions test panel
  5. Go to example-page--logged-in to ensure interaction test shows up

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Code seems sound!

But without UI Tests, I'm going to hold off approving.

(Yes, I know I could manually pull up a local sandbox, but ain't nobody got time for that.)

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Minor nit

code/builders/builder-manager/src/utils/framework.ts Outdated Show resolved Hide resolved
@kylegach
Copy link
Contributor

Is it possible to add a story for Add education links to empty state of interaction tests panel? (Can be in a follow-up PR.)

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Looking great! Just one issue

@@ -54,6 +59,7 @@ export const renderHTML = async (
VERSIONCHECK: JSON.stringify(JSON.stringify(versionCheck), null, 2),
PREVIEW_URL: JSON.stringify(previewUrl, null, 2), // global preview URL
TAGS_OPTIONS: JSON.stringify(await tagsOptions, null, 2),
...stringifiedGlobals,
Copy link
Member

Choose a reason for hiding this comment

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

❤️

code/lib/manager-api/src/tests/versions.test.js Outdated Show resolved Hide resolved
@ShaunEvening ShaunEvening merged commit 82baec1 into next Jan 19, 2024
54 of 58 checks passed
@ShaunEvening ShaunEvening deleted the shaun/jit-learning branch January 19, 2024 15:56
@ShaunEvening
Copy link
Contributor Author

Notes

  • Merged with failing E2E tests as this is a known issue on next
  • Merged with outstanding Chromatic approvals as they were previously unapproved from other work and are not affected by these changes

@github-actions github-actions bot mentioned this pull request Jan 19, 2024
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants