From 898ae88f366d9631a4d492999964a6cafe4bfae1 Mon Sep 17 00:00:00 2001 From: Eli Perelman Date: Sun, 26 Feb 2017 10:37:34 -0600 Subject: [PATCH] Moving boilerplate blurb to FAQs (#69) --- docs/FAQ.md | 21 ++++++++++++++++++--- docs/presets/README.md | 15 --------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/FAQ.md b/docs/FAQ.md index 07163a5..b8f28ff 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -1,11 +1,26 @@ # FAQ -### What is the added value versus all the boilerplate projects out there like [create-react-app](https://github.com/facebookincubator/create-react-app)? +### Why not a boilerplate or alternative? -The proliferation of boilerplate and metapackages is one thing we are trying to reduce. These types of projects +Boilerplates are great resources for scaffolding out application-specific code which +would be difficult or tedious to generate for every project. Unfortunately many projects +also bake in build configuration into this process, causing a lot of duplication. If you +need to make a change to your build steps, you are forced to make that change across all +your similar projects. Using a preset rather than a boilerplate keeps this process DRY. + +Tools like [Create React App](https://github.com/facebookincubator/create-react-app) have +been fantastic improvements to the tooling ecosystem, but unfortunately only work on specific +environments like React, and do not allow simple extensibility of the build configuration. To +answer this, new and similar projects are cropping up to build different types of projects, +often duplicating efforts which miss out on the best practices to share with the other project +types. + +### What is the added value versus all the boilerplate projects out there? + +The proliferation of boilerplate and meta-packages is one thing we are trying to reduce. These types of projects are great, and do serve a purpose. But what if you wanted to make a configuration change across all your projects? You must make config changes in many places, including the original boilerplate, whereas presets -give you the power to confine these changes to a single package. Some of these projects also make a tradeoff +give you the power to confine these changes to a single package. Some of these projects also make a trade-off between ease of set up and black-boxing the configuration. Once you decide to make a configuration change, you are forced to maintain the entire configuration and its dependencies in perpetuity. We believe Neutrino represents a good balance between ease of set up and future extensibility. diff --git a/docs/presets/README.md b/docs/presets/README.md index 1e8038f..00f3271 100644 --- a/docs/presets/README.md +++ b/docs/presets/README.md @@ -23,18 +23,3 @@ you need to make changes. Presets can be easily distributing by publishing them to npm or GitHub and installing them in your project. This also allows others to discover and build projects based on your own presets. - -### Why not a boilerplate or alternative? - -Boilerplates are great resources for scaffolding out application-specific code which -would be difficult or tedious to generate for every project. Unfortunately many projects -also bake in build configuration into this process, causing a lot of duplication. If you -need to make a change to your build steps, you are forced to make that change across all -your similar projects. Using a preset rather than a boilerplate keeps this process DRY. - -Tools like [Create React App](https://github.com/facebookincubator/create-react-app) have -been fantastic improvements to the tooling ecosystem, but unfortunately only works on specific -environments like React, and do not allow simple extensibility of the build configuration. To -answer this new and similar projects are cropping up to build different types of projects, -often duplicating efforts which miss out on the best practices to share with the other project -types.