Skip to content

Update documentation with how to change config in the top level readm… #846

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

Merged
merged 7 commits into from
Sep 22, 2017
Merged

Update documentation with how to change config in the top level readm… #846

merged 7 commits into from
Sep 22, 2017

Conversation

BookOfGreg
Copy link
Contributor

…e. Also reveal how to make use of internal functions

Takes comment from here: #794 (comment) on how to export internal functions for use.

Fixes #802

@gauravtiwari
Copy link
Member

Thanks for this. Please could you move all webpack related doc to docs/webpack.md. You can keep the doc link though inside main README. The idea is to keep the README slimmer 😉

@BookOfGreg
Copy link
Contributor Author

@gauravtiwari No problem. I left in the intro paragraph and link over to webpack.md as that's the minimum that reads well and feels appropriate. It's still quite thin this way.
Is this OK or shall I remove more of it?

docs/webpack.md Outdated
@@ -36,6 +36,14 @@ const customConfig = require('./custom')
module.exports = merge(environment.toWebpackConfig(), customConfig)
```

If you need access to functions within Webpacker's configuration, you can import them like this:
Copy link
Member

Choose a reason for hiding this comment

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

Shall we call it configs instead of functions?

README.md Outdated
environment in their respective files or configure them all in the base
`config/webpack/environment.js` file.

By default, you shouldn't have to make any changes to `config/webpack/*.js`
Copy link
Member

Choose a reason for hiding this comment

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

you shouldn't have => you don't need to

@gauravtiwari
Copy link
Member

Thanks Greg 👍 Looks good, just some minor change to wording

@BookOfGreg
Copy link
Contributor Author

BookOfGreg commented Sep 22, 2017

Tweaked both Readme and Webpack so they are consistent. Thanks for the speedy feedback 👍

@gauravtiwari
Copy link
Member

Thank you. Totally missed the duplicate content between webpack and README so I have taken liberty to remove that. If you could please update TOC with doctoc, I will merge 👍

@BookOfGreg
Copy link
Contributor Author

Done, Thank you 👍

@gauravtiwari gauravtiwari merged commit 6c31733 into rails:master Sep 22, 2017
@gauravtiwari
Copy link
Member

thanks 🍰 🍬

@BookOfGreg BookOfGreg deleted the update-config-documentation branch September 22, 2017 12:08
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.

2 participants