Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge docs repo into this repo: add /docs #1131

Merged
merged 164 commits into from
May 27, 2017
Merged

Merge docs repo into this repo: add /docs #1131

merged 164 commits into from
May 27, 2017

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented May 25, 2017

Issue:

What I did

  • I merged the 3.0.0#source branch for docs into a /docs folder in this repo.
  • More updates to reflect 3.0.0
  • Linting for markdown on this entire repo

How to test

It's already deployed to http://storybook.js.org

thani-sh and others added 30 commits April 15, 2017 16:24
- point references to appropriate monorepo sub packages
- update storybook / react-scripts versions
- remove storybook hub links
Monorepo/storybooks.js.org doc update
Links used to be an add-on, but are now supported natively in
storybook. Updated the docs to reflect that.
Add StoryRouter to the addon gallery
When we moved to github pages, we moved the doc source to `source`
branch, and the `npm run publish` script force pushes the built site to
the `master` branch.
Work in progress: ported storybooks content

Still needs:
- two-level nav hierarchy
- styling improvements
- stories ;-)
Add note about webpack version
Added PR template similar to storybook repo
Use index.md so that images show properly in github, e.g.:

```md
![Login Form](../static/login_form.png)
```
@ndelangen
Copy link
Member Author

@mnmtanish @shilman @mthuret Would you like to review this?

@ndelangen ndelangen changed the title merge docs to this repo 3.0.0 3.0.0 docs by merging docs repo into this repo May 26, 2017
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Fingers crossed!

@@ -21,22 +21,19 @@
},
"homepage": "https://github.com/storybooks/storybook/tree/master/addons/actions",
"devDependencies": {
"@storybook/addons": "^3.0.0-rc.0",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to docs, but we'll let it slide 😉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ndelangen Is there a chance that you can remember why was it needed to move @storybook/addons frop peerDeps to direct deps?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Absolutely 0 chance of me remembering, sorry.

Though I think it makes sense, and without lock-files would work great.
Having these lockfiles really messes up the singleton module method, which lib/addons depends on to function.

Copy link
Member

@Hypnosphi Hypnosphi Nov 20, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

without lock-files would work great

But it's probably the only reason users have to use the same patch version for all the @storybook dependencies (regardless of whether do they use lockfile)

@shilman shilman merged commit 360fb0b into master May 27, 2017
@ndelangen ndelangen deleted the ndelangen/dev branch May 27, 2017 00:27
@ndelangen
Copy link
Member Author

It would appear like a deploy to gh-pages wasn't succesful, can you look into it @shilman

@shilman shilman mentioned this pull request May 27, 2017
@ndelangen ndelangen changed the title 3.0.0 docs by merging docs repo into this repo Merge docs repo into this repo: add /docs May 27, 2017
@ndelangen ndelangen changed the title Merge docs repo into this repo: add /docs Merge docs repo into this repo: add /docs May 27, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.