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

Synced changes from new-docs to CONTRIBUTING.md #1911

Merged
merged 3 commits into from
Sep 29, 2017

Conversation

dangreenisrael
Copy link
Member

new-docs PR Reference: #1886
orignal PR (to master) #1906

What I did

Synced CONTRIBUTING.md with updated in new-docs branch

How to test

N/A: Just added docs

@codecov
Copy link

codecov bot commented Sep 29, 2017

Codecov Report

Merging #1911 into release/3.3 will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           release/3.3    #1911   +/-   ##
============================================
  Coverage        22.24%   22.24%           
============================================
  Files              325      325           
  Lines             6519     6519           
  Branches           830      830           
============================================
  Hits              1450     1450           
+ Misses            4454     4441   -13     
- Partials           615      628   +13
Impacted Files Coverage Δ
app/react/src/server/config/babel.js 0% <0%> (-100%) ⬇️
lib/ui/src/modules/api/configs/init_api.js 40.42% <0%> (ø) ⬆️
lib/ui/src/modules/shortcuts/actions/shortcuts.js 22.41% <0%> (ø) ⬆️
addons/info/src/components/types/ObjectType.js 14.28% <0%> (ø) ⬆️
lib/ui/src/modules/ui/components/menu_item.js 19.14% <0%> (ø) ⬆️
addons/knobs/src/components/types/Boolean.js 11.62% <0%> (ø) ⬆️
.../src/modules/ui/components/stories_panel/header.js 29.62% <0%> (ø) ⬆️
lib/ui/src/modules/ui/libs/filters.js 47.36% <0%> (ø) ⬆️
addons/info/src/components/markdown/htags.js 30% <0%> (ø) ⬆️
addons/info/src/components/types/PrettyPropType.js 10.2% <0%> (ø) ⬆️
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8003d59...a6e9889. Read the comment docs.

CONTRIBUTING.md Outdated

#### React and Vue

1. DO NOT RUN `yarn` or `yarn install`
Copy link
Member

Choose a reason for hiding this comment

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

In fact nothing wrong will happen if you do this. With yarn workspaces, you can run yarn anywhere, and it will bootstrap everything

@Hypnosphi
Copy link
Member

Hypnosphi commented Sep 29, 2017

Now your changes partly duplicate this section (and the 2c subsection above it): https://github.com/storybooks/storybook/blob/eaea3985b31fc290879cd0fbbb811f45b2fb4e52/CONTRIBUTING.md#reproductions

@dangreenisrael
Copy link
Member Author

@Hypnosphi I think that the duplicated steps are relevant in both sections, and if someone is following a guide to setup a dev environment they shouldn't have to go to different parts of the page to get everything working.

@dangreenisrael dangreenisrael force-pushed the sync-CONTRIBUTING-on-master-with-new-docs branch from eaea398 to 14a4e8c Compare September 29, 2017 02:19
@dangreenisrael dangreenisrael force-pushed the sync-CONTRIBUTING-on-master-with-new-docs branch from 14a4e8c to a83cad7 Compare September 29, 2017 02:33
@Hypnosphi
Copy link
Member

@ndelangen I don't really have a strong opinion here. What do you think?

CONTRIBUTING.md Outdated

##### 2. Link

**_Note_**: This process is the same fore `@storybook/vue`, `@storybook/addon-foo`, etc
Copy link
Member

Choose a reason for hiding this comment

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

typo: fore => for

CONTRIBUTING.md Outdated

1. Go to your storybook _root_ directory
2. `yarn dev`
3. Wait for the output to stop
Copy link
Member

Choose a reason for hiding this comment

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

I find the wording here vague.. Someone could very easily misunderstand and wait for the program to exit.
It won't.

```sh
yarn link @storybook/react
```
Within the `examples` folder of the Storybook repo, you will find kitchen sink examples of storybook implementations for the various platforms that storybook supports.
Copy link
Member

Choose a reason for hiding this comment

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

Could you add something along the lines of:

Not only do these show many of the options and addons available, they are also automatically linked to all the development packages. We highly encourage you to use these to develop/test contributions on.

Copy link
Member Author

Choose a reason for hiding this comment

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

@ndelangen
Copy link
Member

ndelangen commented Sep 29, 2017

Maybe the answer is to split them apart into multiple pages?

The new docs will house a lot of markdown based docs. We can easily link to such documents from CONTRIBUTING.md?

@dangreenisrael
Copy link
Member Author

Should we perhaps have this one large doc as a temporary solution, until the new-docs are ready? In the new docs, these would indeed be on different pages.

@ndelangen
Copy link
Member

That sounds like a perfectly reasonable way forward 👍

PS. I'm not @norbert on github 🙅‍♂️

@ndelangen ndelangen merged commit 09d2db5 into release/3.3 Sep 29, 2017
@ndelangen ndelangen deleted the sync-CONTRIBUTING-on-master-with-new-docs branch September 29, 2017 20:58
@ndelangen
Copy link
Member

Thanks @dangreenisrael !! 💯 🕶 💪

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants