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

docs: use serve instead of http-server #29642

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

cgatian
Copy link
Contributor

@cgatian cgatian commented Nov 18, 2024

The recommended approach to render a preview of your static storybook uses http-server. However, this doesn't render the storybook correctly as no stories are found. Using serve works.

Note: I didn't dig into why http-server is broken.

Closes NA

What I did

I attempted to serve my static build of storybook-static using the docs recommended approach. This did not properly render the stories.

I found another PR that noted the same problem. They switched to serve

Update docs to use serve instead of http-server.

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

  1. Build a static version of storybook.
  2. Attempt to serve it using the recommended approach in the docs (npx http-server ./storybook-static).
  3. Notice no stories are rendered.
  4. Use npx serve ./storybook-static
  5. Notice stories are rendered.

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-storybook/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>

http-server doesnt render the storybook correctly
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

Copy link

nx-cloud bot commented Nov 18, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit e15d37e. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes
Copy link
Contributor

@cgatian thanks for taking the time to put together this pull request and helping us improve the documentation by catching this small issue with the package. However, before we can merge this, I was wondering if you're able to get an issue/discussion here in the monorepo so that we can take a better look at it, provide a reproduction and link this pull request. Mostly the reason I'm asking is because we have some other references to the package (i.e., the test-runner documentation) and we'll probably need to vet and adjust it as well.

Let me know and we'll go from there.

Hope you have a great day.

Stay safe

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.

2 participants