Skip to content

Commit

Permalink
FIX spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
ndelangen committed May 27, 2017
1 parent 79d9838 commit db3cd0b
Show file tree
Hide file tree
Showing 33 changed files with 124 additions and 50 deletions.
74 changes: 74 additions & 0 deletions .spelling
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,77 @@ styleguide-type
styleguides
angularjs
api
github
config
cra
PRs
cleanup
2
ES2016
prerelease
rc
npm
apollo
codemod
storyshots
graphql
lerna
eslint
js
CommonJS
IO
reflow
Node.js.
dialog
10
unisolated
3
13
Browserify
bundlers
2013
centered
center
GraphiQL
graphiql
url
javascript
storyshots'
storybook.js.org
CRNA
postmessage
websocket
EventEmitter
codemods
jscodeshift
npm3
HMR
Redux
storybook-ui
react-komposer
redux
serializable
params
- addons/actions/node_modules/@storybook/addons/README.md
storybooks.js.org
- addons/actions/node_modules/asap/README.md
YuzuJS
setImmediate
Malte
Ubl
Katić
Domenic
Kowal
Zakas
- addons/actions/node_modules/balanced-match/README.md
Gruber
julian
juliangruber.com
- addons/actions/node_modules/brace-expansion/README.md
Schlueter
- addons/links/README.md
linkTo
- lib/ui/README.md
setOptions
setStories
onStory
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ This is a major release with breaking changes. See our [migration guide](https:/
- First pass at update the contribution instructions (<https://github.com/storybooks/storybook/pulls/982>)
- Remove text transform uppercase for knob labels (<https://github.com/storybooks/storybook/pulls/991>)
- Update links in PRs section of CONTRIBUTING.md (<https://github.com/storybooks/storybook/pulls/992>)
- Updated dead getstorybook.io links to storybooks.js.org (<https://github.com/storybooks/storybook/pulls/988>)
- Updated dead getstorybook.io links to storybook.js.org (<https://github.com/storybooks/storybook/pulls/988>)
- Do not ignore story.js in prepublish (<https://github.com/storybooks/storybook/pulls/973>)
- addon-info: make the info overlay be fixed (<https://github.com/storybooks/storybook/pulls/914>)
- Update lerna to the latest version 🚀 (<https://github.com/storybooks/storybook/pulls/969>)
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,9 @@ If an issue is a `bug`, and it doesn't have a clear reproduction that you have p

- Unreproducible issues should be closed if it's not possible to reproduce them (if the reporter drops offline, it is reasonable to wait 2 weeks before closing).

- `bug`s should be labeled `merged` when merged, and be closed when the issue is fixed and released.
- `bug`s should be labelled `merged` when merged, and be closed when the issue is fixed and released.

- `feature`s, `maintenance`s, `greenkeeper`s should be labeled `merged` when merged, and closed when released or if the feature is deemed not appropriate.
- `feature`s, `maintenance`s, `greenkeeper`s should be labelled `merged` when merged, and closed when released or if the feature is deemed not appropriate.

- `question / support`s should be closed when the question has been answered. If the questioner drops offline, a reasonable period to wait is two weeks.

Expand Down
2 changes: 1 addition & 1 deletion HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## v.Next

- Deprecated `{ linkTo, action }` as built-in addons: <https://github.com/storybooks/storybook/issues/1017>. From 3.0 use them as you would [any other addon](https://storybooks.js.org/docs/react-storybook/addons/using-addons/).
- Deprecated `{ linkTo, action }` as built-in addons: <https://github.com/storybooks/storybook/issues/1017>. From 3.0 use them as you would [any other addon](https://storybook.js.org/docs/react-storybook/addons/using-addons/).

Before:

Expand Down
6 changes: 3 additions & 3 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can find the guide to upgrading your webpack config [on webpack.js.org](http
All our packages have been renamed and published to npm as version 3.0.0.

> We have adopted the same versioning strategy as have been adopted by babel, jest and apollo.
> It's a strategy best suited for ecosystem type tools, which consist of many seperately installable features / packages.
> It's a strategy best suited for ecosystem type tools, which consist of many separately installable features / packages.
> We think this describes storybook pretty well.
The new package names are:
Expand Down Expand Up @@ -59,13 +59,13 @@ The new package names are:

If your codebase is small, it's probably doable to just replace them by hand. (in your codebase and in `package.json`).

But if you have a lot of occurances in your codebase, you can use a [codemod we created](./lib/codemod) for you.
But if you have a lot of occurrences in your codebase, you can use a [codemod we created](./lib/codemod) for you.

> A codemod makes automatic changed to your app's code.
You have to change your `package.json`, prune old and install new dependencies by hand.

`npm prune` will remove all dependecies from `node_modules` which are no longer referenced in `package.json`.
`npm prune` will remove all dependencies from `node_modules` which are no longer referenced in `package.json`.

### Deprecated embedded addons

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ It allows you to browse a component library, view the different states of each c

Storybook runs outside of your app. This allows you to develop UI components in isolation, which can improve component reuse, testability, and development speed. You can build quickly without having to worry about application-specific dependencies.

Storybook comes with a lot of [addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.
Storybook comes with a lot of [addons](https://storybook.js.org/docs/react-storybook/addons/introduction) for component design, documentation, testing, interactivity, and so on. Storybook's easy-to-use API makes it easy to configure and extend in various ways. It has even been extended to support React Native development for mobile.

## Table of contents

Expand All @@ -45,7 +45,7 @@ getstorybook

Once it's installed, you can `npm run storybook` and it will run the development server on your local machine, and give you a URL to browse some sample stories.

For full documentation on using Storybook visit: [storybooks.js.org](https://storybooks.js.org)
For full documentation on using Storybook visit: [storybook.js.org](https://storybook.js.org)

## Projects

Expand Down Expand Up @@ -95,14 +95,14 @@ We welcome contributions to Storybook!
- `npm run lint:js` - will check js
- `npm run lint:markdown` - will check markdown + code samples

- `npm run lint:js -- --fix` - will autofix js
- `npm run lint:markdown -- -o` - will autofix markdown
- `npm run lint:js -- --fix` - will automatically fix js
- `npm run lint:markdown -- -o` - will automatically fix markdown

#### `npm run test`

> boolean check if unittests all pass - uses jest
> boolean check if unit tests all pass - uses jest
- `npm run test:watch` - will run tests in watchmode
- `npm run test:watch` - will run tests in watch-mode

### Backers

Expand Down
2 changes: 1 addition & 1 deletion addons/actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Addon Actions can be used to display data received by event handlers in [Storybook](https://storybooks.js.org).
Storybook Addon Actions can be used to display data received by event handlers in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react) and
Expand Down
2 changes: 1 addition & 1 deletion addons/centered/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybooks.js.org).
Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
Expand Down
2 changes: 1 addition & 1 deletion addons/comments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Comments Addon allows you to add comments for your stories in [Storybook](https://storybooks.js.org).
Storybook Comments Addon allows you to add comments for your stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
Expand Down
2 changes: 1 addition & 1 deletion addons/graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook GraphiQL Addon can be used to display the GraphiQL IDE with example queries in [Storybook](https://storybooks.js.org).
Storybook GraphiQL Addon can be used to display the GraphiQL IDE with example queries in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
Expand Down
2 changes: 1 addition & 1 deletion addons/info/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Info Addon will show additional information for your stories in [Storybook](https://storybooks.js.org).
Storybook Info Addon will show additional information for your stories in [Storybook](https://storybook.js.org).
Useful when you want to display usage or other types of documentation alongside your story.

This addon works with Storybook for:
Expand Down
6 changes: 3 additions & 3 deletions addons/knobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Addon Knobs allow you to edit React props dynamically using the Storybook UI.
You can also use Knobs as a dynamic variable inside stories in [Storybook](https://storybooks.js.org).
You can also use Knobs as a dynamic variable inside stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
Expand Down Expand Up @@ -137,9 +137,9 @@ const options = {
const value = number(label, defaultValue, options);
```

### color
### colour

Allows you to get a color from the user.
Allows you to get a colour from the user.

```js
const label = 'Color';
Expand Down
2 changes: 1 addition & 1 deletion addons/links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

The Storybook Links addon can be used to create links between stories in [Storybook](https://storybooks.js.org).
The Storybook Links addon can be used to create links between stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react) and
Expand Down
2 changes: 1 addition & 1 deletion addons/notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

Storybook Addon Notes allows you to write notes for your stories in [Storybook](https://storybooks.js.org).
Storybook Addon Notes allows you to write notes for your stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
Expand Down
2 changes: 1 addition & 1 deletion addons/options/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

The Options addon can be used to set configure the [Storybook](https://storybooks.js.org) UI.
The Options addon can be used to set configure the [Storybook](https://storybook.js.org) UI.

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react) and
Expand Down
4 changes: 2 additions & 2 deletions addons/storyshots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[![BCH compliance](https://bettercodehub.com/edge/badge/storybooks/storybook)](https://bettercodehub.com/results/storybooks/storybook) [![codecov](https://codecov.io/gh/storybooks/storybook/branch/master/graph/badge.svg)](https://codecov.io/gh/storybooks/storybook)
[![Storybook Slack](https://storybooks-slackin.herokuapp.com/badge.svg)](https://storybooks-slackin.herokuapp.com/)

StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybooks.js.org/).
StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybook.js.org/).

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react) and
Expand Down Expand Up @@ -100,7 +100,7 @@ initStoryshots({

### `framework`

If you are running tests from outside of your app's directory, storyshot's detection of which framework you are using may fail. Pass `"react"` or `"react-native"` to short-circuit this.
If you are running tests from outside of your app's directory, storyshots' detection of which framework you are using may fail. Pass `"react"` or `"react-native"` to short-circuit this.

### `test`

Expand Down
2 changes: 1 addition & 1 deletion app/react-native/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ With Storybook for React Native you can design and develop individual React Nati

![Storybook Screenshot](docs/assets/readme/screenshot.png)

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybook.js.org)

## Getting Started

Expand Down
2 changes: 1 addition & 1 deletion app/react-native/src/server/addons.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ import '@storybook/addon-links/register';

deprecate(
() => {},
'@storybook/react-native/addons is deprecated. See https://storybooks.js.org/docs/react-storybook/addons/using-addons/'
'@storybook/react-native/addons is deprecated. See https://storybook.js.org/docs/react-storybook/addons/using-addons/'
)();
12 changes: 6 additions & 6 deletions app/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ cd my-react-app
getstorybook
```

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybook.js.org)

* * *

Storybook also comes with a lot of [addons](https://storybooks.js.org/docs/react-storybook/addons/introduction) and a great API to customize as you wish.
You can also build a [static version](https://storybooks.js.org/docs/react-storybook/basics/exporting-storybook) of your storybook and deploy it anywhere you want.
Storybook also comes with a lot of [addons](https://storybook.js.org/docs/react-storybook/addons/introduction) and a great API to customize as you wish.
You can also build a [static version](https://storybook.js.org/docs/react-storybook/basics/exporting-storybook) of your storybook and deploy it anywhere you want.

Here are some featured storybooks that you can reference to see how Storybook works:

Expand All @@ -37,6 +37,6 @@ Here are some featured storybooks that you can reference to see how Storybook wo

## Docs

- [Basics](https://storybooks.js.org/docs/react-storybook/basics/introduction)
- [Configurations](https://storybooks.js.org/docs/react-storybook/configurations/default-config)
- [Addons](https://storybooks.js.org/docs/react-storybook/addons/introduction)
- [Basics](https://storybook.js.org/docs/react-storybook/basics/introduction)
- [Configurations](https://storybook.js.org/docs/react-storybook/configurations/default-config)
- [Addons](https://storybook.js.org/docs/react-storybook/addons/introduction)
2 changes: 1 addition & 1 deletion app/react/addons.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ import '@storybook/addon-links/register';

deprecate(
() => {},
'@storybook/react/addons is deprecated. See https://storybooks.js.org/docs/react-storybook/addons/using-addons/'
'@storybook/react/addons is deprecated. See https://storybook.js.org/docs/react-storybook/addons/using-addons/'
)();
2 changes: 1 addition & 1 deletion app/react/demo/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
href="https://storybook.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
2 changes: 1 addition & 1 deletion examples/cra-storybook/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
href="https://storybook.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ exports[`Storyshots Welcome to Storybook 1`] = `
Have a look at the
<a
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
href="https://storybook.js.org/docs/react-storybook/basics/writing-stories"
style={
Object {
"borderBottom": "1px solid #1474f3",
Expand Down
2 changes: 1 addition & 1 deletion examples/test-cra/src/stories/Welcome.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ export default class Welcome extends React.Component {
{' '}
<a
style={styles.link}
href="https://storybooks.js.org/docs/react-storybook/basics/writing-stories"
href="https://storybook.js.org/docs/react-storybook/basics/writing-stories"
target="_blank"
>
Writing Stories
Expand Down
2 changes: 1 addition & 1 deletion lib/addons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ It stores addon loaders, communication channel and other resources which can be

* * *

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybook.js.org)
2 changes: 1 addition & 1 deletion lib/channel-postmessage/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ const channel = createChannel({ key: 'postmsg-key' })

* * *

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybook.js.org)
2 changes: 1 addition & 1 deletion lib/channel-websocket/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ const channel = createChannel({ url: 'ws://localhost:9001' })

* * *

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybooks.js.org)
2 changes: 1 addition & 1 deletion lib/channels/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ const channel = addons.getChannel();

* * *

For more information visit: [storybooks.js.org](https://storybooks.js.org)
For more information visit: [storybook.js.org](https://storybook.js.org)
Loading

0 comments on commit db3cd0b

Please sign in to comment.