[Docs] Fix broken links and more

This commit is contained in:
Stefan Ålund
2020-07-15 12:24:15 +02:00
parent 8ec6ed5170
commit f59dd3a073
9 changed files with 8 additions and 6 deletions
@@ -1,37 +0,0 @@
# Contributing to Storybook
## Creating a new Story
> A Story basically represents a single visual state of a component.
To create a new story, create a new file located alongside the component you
want to document on Storybook.
See below an example of the structure:
```
core
└── src
└── components
└── Progress
├── Progress.tsx
└── Progress.stories.tsx
```
> _Note: make sure your component story file has the following format
> componentName.stories.tsx_
## Running locally
Go to `packages/storybook`, run `yarn install` and install the dependencies,
then run the following on your command line: `yarn start`
![](running-storybook.png)
_You should see a log like the image above._
If everything worked out, your server will be running on **port 6006**, go to
your browser and navigate to `http://localhost:6006/`. You should be able to
navigate and see the Storybook page.
![](storybook-page.png)
+3 -3
View File
@@ -62,8 +62,8 @@ collection of tutorials that will guide you through setting up and extending an
instance of Backstage with your own plugins.
- [Development Environment](development-environment.md)
- [Create a Backstage Plugin](create-a-plugin.md)
- [Structure of a Plugin](structure-of-a-plugin.md)
- [Utility APIs](utility-apis.md)
- [Create a Backstage Plugin](../plugins/create-a-plugin.md)
- [Structure of a Plugin](../plugins/structure-of-a-plugin.md)
- [Utility APIs](../api/utility-apis.md)
[Back to Docs](../README.md)
Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB