Improve Intro to Storybook. Get Started chapter #297
Conversation
Added additional paragraph regarding serving static file
| @@ -67,7 +67,8 @@ If you want to modify the styling, the source LESS files are provided in the Git | |||
| To match the intended design, you'll need to download both the font and icon directories and place its contents inside your `public` folder. | |||
|
|
|||
| <div class="aside"> | |||
| <p>We’ve used <code>svn</code> (Subversion) to easily download a folder of files from GitHub. If you don’t have subversion installed or want to just do it manually, you can grab the folders directly <a href="https://github.com/chromaui/learnstorybook-code/tree/master/public">here</a>.</p></div> | |||
| <p>We’ve used <code>svn</code> (Subversion) to easily download a folder of files from GitHub. If you don’t have subversion installed or want to just do it manually, you can grab the folders directly <a href="https://github.com/chromaui/learnstorybook-code/tree/master/public">here</a>.</p> | |||
| <p>To configure Storybook to serve static content refer to <a href="https://storybook.js.org/docs/configurations/serving-static-files">serving static content</a>.</p></div> | |||
There was a problem hiding this comment.
@orelmax thank you for this small but rather on topic contribution. But i think we can do better. Probably go with something like:
<p>If you want to learn more about serving static content in your Storybook, you can read more about it in <a href="https://storybook.js.org/docs/configurations/serving-static-files">here</a>.</p>There was a problem hiding this comment.
Yeah, this sounds better. I've finished the whole tutorial but didn't found any mentions of serving statics configuration and thought it'd improve people experience.
There was a problem hiding this comment.
@orelmax that's beyond of the scope of the tutorial, as it's focus is on informing you in this case how to set it up with a practical example and throughout it mention the core functionalities at your disposal. If you don't mind i'm ok with merging this and i'll do it tomorrow (sunday) if you don't mind.
Slightly rephrase of serving static content note
|
@orelmax Thanks for the contribution. I'm a bit confused, when you were going through the tutorial did you put the assets in the iirc We chose the Serving static assets via SB is typically a more advanced use case. I'm concerned people will go off track if we mention static asset hosting this early in the tutorial. |
|
@domyen i've thinking a bit more about this and why not move this to it's own, at the lack of a better word recipe. I mean that we could grab this case and other cases like for instance how to use graphql and storybook and add them to the visual testing handbook. Turning it into a Storybook "cookbook" (pardon the bad pun) for quick reference. Making use of that content and complementing the official docs. Let me know what do you think |
|
That's an excellent suggestion @jonniebigodes. We have an open issue to create another guide with this type of content. I'll make note of it there! :) I don't think we should merge this PR because it's an advanced technique and I'd prefer the guide be focused on the beginner experience. (Obviously, still very appreciative for @orelmax for the PR 🙇♂️) |
|
@domyen i'm going to close this then per your feedback. @orelmax to not let your work go to waste so to speak, towards the end of the week i'm going to draft a pr with a work in progress regarding the issue mentioned and i would like for you to continue your work there. I have a draft on paper on how the content could be outlined and with that we can address the issue. Sounds good? |
Added additional paragraph regarding serving static files to Add assets section