Doc updates to prepare for FastBoot 1.0 #70
Conversation
kratiahuja
changed the title
kratiahuja
force-pushed
the
prepare-fastboot-1.0
branch
from
24cfced to
a2677c3
Compare
This PR fixes issues on the website which called to use `ember fastboot`. With FastBoot 1.0 and starting with the RC builds, `ember fastboot` will be gone. Also tweaked wording a bit to explain the new build in short.
markdown/docs/user-guide.md
Outdated
| @@ -764,8 +748,8 @@ The server offers an [Express middleware][express] that can be integrated into a | |||
|
|
|||
| ```javascript | |||
| var server = new FastBootServer({ | |||
| appFile: appFile, | |||
| vendorFile: vendorFile, | |||
| appFiles: [appFile, appFile-fastboot], | |||
There was a problem hiding this comment.
appFile-fastboot is likely not correct, as it is not a valid variable name.
There was a problem hiding this comment.
ohoo yeah, I meant appFastBootFile to denote the additional asset for overrides
There was a problem hiding this comment.
@stefanpenner fixed.
|
|
|
@stefanpenner fixed the naming a bit. can you please take a look again when you have some time? |
|
@tomdale I think your eyes on this is important. |
kratiahuja
force-pushed
the
prepare-fastboot-1.0
branch
from
2724a28 to
f7d836b
Compare
|
@tomdale pinging again to see if you had a chance to review this PR? |
|
Apologies for the delay. This is first on my list for tomorrow. |
markdown/docs/addon-author-guide.md
Outdated
| when you deploy an Ember app, the FastBoot server also loads these two | ||
| files. | ||
| FastBoot works by running a singular build as it was running without the FastBoot | ||
| addon being installed. It basically loads the same assets `app.js` and `vendor.js` |
There was a problem hiding this comment.
Perhaps this could be simplified a bit.
FastBoot works by running a singular build of your application, leveraging the common `app.js` and `vendor.js` files on the server and browser clients. However, on the server an additional asset `app-fastboot.js` will leveraged. This asset contains FastBoot specific overrides defined by the application or other addons.
There was a problem hiding this comment.
Sounds much better :). Just tweaked the "server and browser clients" to call "browser and Node" since everywhere else we refer it as Node.
markdown/docs/addon-author-guide.md
Outdated
| The FastBoot addon sets the `EMBER_CLI_FASTBOOT` environment variable | ||
| when it is building the FastBoot version of the application. Use | ||
| this to prevent the inclusion of a library in the FastBoot build: | ||
| The FastBoot addon simply provides the FastBoot server a manifest of |
There was a problem hiding this comment.
Could 'simply' be removed from this sentence without changing the overall meaning?
kratiahuja
force-pushed
the
prepare-fastboot-1.0
branch
from
b405e6d to
16c26a5
Compare
|
@kristoferbaxter Thanks for the feedback and apologies for the delay here. Updated per your suggestion. Could you please take another look? |
kratiahuja
force-pushed
the
prepare-fastboot-1.0
branch
from
16c26a5 to
7202c82
Compare
|
LGTM! |
|
@stefanpenner any objections to merging this? If not, I'll merge this and we will be one step closer to 1.0 :) |
|
@kristoferbaxter thanks for the review! |
Fixes #54
This PR fixes issues on the website which called to use
ember fastboot. With FastBoot 1.0 and starting with the RC builds,ember fastbootwill be gone. Also tweaked wording a bit to explain the new build in short.The irony this app is using
ember fastboot --serve-assetsinstead ofember serve. Going to bump ember version and using ember serve in a seperate PR.cc: @stefanpenner @tomdale