diff options
| author | Michael Mitchell <michael.mitchell@getg5.com> | 2014-06-27 10:54:58 -0700 |
|---|---|---|
| committer | Michael Mitchell <michael.mitchell@getg5.com> | 2014-07-02 09:54:42 -0700 |
| commit | 266e8db6fa315143a368d9b0c54e7f5c0b54efc6 (patch) | |
| tree | acf8d5e4f6e3830811698eafca32168bd69da734 /guides | |
| parent | f838caf350c3405ebdf10a6c6171adfa0a840905 (diff) | |
| download | rails-266e8db6fa315143a368d9b0c54e7f5c0b54efc6.tar.gz rails-266e8db6fa315143a368d9b0c54e7f5c0b54efc6.tar.bz2 rails-266e8db6fa315143a368d9b0c54e7f5c0b54efc6.zip | |
[ci skip] Changes some wording to better foreshadow what is coming up later.
This should prevent some anxiety readers may experience when the doc goes into something different than what it just explained. Also clarifies a statement about priority in engines and application environments
[ci skip] fixes double `the`
[ci skip] more clarifications
[ci skip] changes from tics to quotes
Diffstat (limited to 'guides')
| -rw-r--r-- | guides/source/engines.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/guides/source/engines.md b/guides/source/engines.md index e630e3d93b..a5f8ee27b8 100644 --- a/guides/source/engines.md +++ b/guides/source/engines.md @@ -31,10 +31,12 @@ Engines are also closely related to plugins. The two share a common `lib` directory structure, and are both generated using the `rails plugin new` generator. The difference is that an engine is considered a "full plugin" by Rails (as indicated by the `--full` option that's passed to the generator -command). This guide will refer to them simply as "engines" throughout. An -engine **can** be a plugin, and a plugin **can** be an engine. +command). We'll actually be using the `--mountable` option here, which includes +all the features of `--full`, and then some. This guide will refer to these +"full plugins" simply as "engines" throughout. An engine **can** be a plugin, +and a plugin **can** be an engine. -The engine that will be created in this guide will be called "blorgh". The +The engine that will be created in this guide will be called "blorgh". This engine will provide blogging functionality to its host applications, allowing for new articles and comments to be created. At the beginning of this guide, you will be working solely within the engine itself, but in later sections you'll @@ -49,9 +51,8 @@ guide. It's important to keep in mind at all times that the application should **always** take precedence over its engines. An application is the object that -has final say in what goes on in the universe (with the universe being the -application's environment) where the engine should only be enhancing it, rather -than changing it drastically. +has final say in what goes on in its environment. The engine should +only be enhancing it, rather than changing it drastically. To see demonstrations of other engines, check out [Devise](https://github.com/plataformatec/devise), an engine that provides @@ -745,8 +746,9 @@ reason, the engine should not hardcode associations specifically for a `User` class. To keep it simple in this case, the application will have a class called `User` -that represents the users of the application. It can be generated using this -command inside the application: +that represents the users of the application (we'll get into making this +configurable further on). It can be generated using this command inside the +application: ```bash rails g model user name:string |