1818767 - Add link to our deployed Storybook instance in our docs

Status: RESOLVED FIXED

(Toolkit :: UI Widgets, task, P3)

Description

[Tim Giles [:tgiles]]

Now that Bug 1766701 has landed and our existing Storybook/reusable components documentation is more accessible, we should also link to our deployed storybook instance in these docs. Here is the deployed Storybook instance. We should probably add this link in the Storybook for Firefox doc under the title heading

Comment 1

[Tim Giles [:tgiles]]

To help Mozilla out with this bug, here's the steps:

1. Comment here on the bug that you want to volunteer to help.
   This will tell others that you're working on the next steps.
2. Download and build the Firefox source code
   • If you have any problems, please ask on Element/Matrix in the #introduction channel. They're there to help you get started.
   • You can also read the Developer Guide, which has answers to most development questions.
3. Start working on this bug.
   • You will need to modify README.storybook.stories.md and add a link to https://firefoxux.github.io/firefox-desktop-components/?path=/story/docs-reusable-widgets--page after the first sentence in this doc.
   • You can verify your changes using ./mach doc and waiting for all the docs dependencies to be installed and ran.
   • If you have any problems with this bug, please comment on this bug and set the needinfo flag for me. Also, you can find me and my teammates on the #reusable-components channel on Element/Matrix most hours of most days.
4. Build your change with mach doc and verify your changes in the resulting doc. Also check your changes for adherence to our style guidelines by using mach lint.
5. Submit the patch (including an automated test, if applicable) for review. Mark me as a reviewer so I'll get an email to come look at your code.
   • How to Submit a Patch
   • This is when the bug will be assigned to you.
6. After a series of reviews and changes to your patch, I'll push it to autoland.
   • If there are changes requested, please read the "To update a submitted patch" section to ensure you don't accidentally create a duplicate revision!
   • Your code will soon be shipping to Firefox users worldwide!

Comment 2

[Ganna]

hi, I am outreachy applicant and would like to be assigned to this issue

Comment 3

[Abhishek[: unavailable till 11 May]]

Hello, I am also looking at this issue, as it is unassigned now. I have figured out the code where changes are required. But I have a doubt here. You mentioned adding the link at the end of the first sentence in the doc. This means after the end of this whole line, "Storybook is a component library to document our design system, reusable components, and any specific components you might want to test with dummy data." Or do we have to add the link for the word "storyBook" because when some clicks on storyBook will get retired to this new link? Please let me know. Thanks.

Comment 4

[Abhishek[: unavailable till 11 May]]

I have made the changes as mentioned. Should I make a commit for review ?

Comment 5

[Abhishek[: unavailable till 11 May]]

Attachment: Bug 1818767 - Added link to deployed Storybook instance in docs. r=tgiles

Comment 6

[Abhishek[: unavailable till 11 May]]

Sir, I have deleted the previous file I was working on, so I am making a new patch for it.

Comment 7

[Abhishek[: unavailable till 11 May]]

Attachment: Bug 1818767 - Add link to our deployed Storybook instance in our docs updated patch r=tgiles

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e37f1e1e3ddd
Add link to our deployed Storybook instance in our docs updated patch r=tgiles

Comment 9

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/e37f1e1e3ddd