ui: Storybook Install

[johncowen]

We've held off on installing storybook into the main project for quite a while now, holding out for some approach which meant that storybook would be installed only if you wanted to work on components.

That approach hasn't materialised and we really could do with a nice way to catalog and work on our components in a more isolated manner, so this PR installs storybook straight into the main UI project.

I've added one basic story here for our simple <Notice /> component, but we should aim to add more and more stories for existing and new components as we move forwards with it.

[mikemorris]

I know you've discussed previously using workspaces to avoid installing devdependencies like Storybook into the main project, or possibly a three-workspace approach like ui and storybook namespaces both dependent on a shared common components workspace - was there a reason those approaches didn't work in practice? Does this implementation mean we should scrap the use of workspaces entirely and revert that change?

[johncowen]

Hey @mikemorris

I had a brief-ish look at using Storybook like you mention above, mainly to see if it was straightforward to structure it like this or there was a recognized way of using storybook as a 'sibling' project. After spending a while with it it didn't seem something that was straightforwards, but I don't think this should put us off doing it in the future, or necessarily using workspaces altogether.

After looking into it though I figured it would be best to install Storybook into the project so as not to block us from moving forwards with storybook-ing our components. At the end of the day I don't want me being picky over how I ideally want to structure things to get in the way of creating a bunch of stories, especially when no matter how storybook is installed I would still like the stories themselves to live in the same folder as the component itself (as if the case in this PR) - i.e. if we move the storybook install in future the stories themselves wouldn't necessarily change.

As for workspaces, we'd spoken about having other sibling projects - not just storybook related - so theres still potential benefit to be had there (although unfortunately not as much as we'd originally hoped). I definitely wouldn't want to scrap the idea just yet as that would just mean another bunch of churn.

[mikemorris]

Sounds reasonable to me!

[hashicorp-ci]

🍒✅ Cherry pick of commit d5d4155 onto release/1.9.x succeeded!