diff options
author | Guillermo Iguaran <guilleiguaran@gmail.com> | 2014-09-08 23:17:02 -0500 |
---|---|---|
committer | Guillermo Iguaran <guilleiguaran@gmail.com> | 2014-09-08 23:17:02 -0500 |
commit | 89d897e3a7cf3b6b4f9f03f7f3c2003d53741e30 (patch) | |
tree | 513a377d0bf4d811aa80f449d8481290643718f8 | |
parent | fb110381481fe79fa2921d08a60d343d3ea2b363 (diff) | |
parent | 453f5ecfde5148418deb7ef936ca907c48f84dc5 (diff) | |
download | rails-89d897e3a7cf3b6b4f9f03f7f3c2003d53741e30.tar.gz rails-89d897e3a7cf3b6b4f9f03f7f3c2003d53741e30.tar.bz2 rails-89d897e3a7cf3b6b4f9f03f7f3c2003d53741e30.zip |
Merge pull request #16845 from todd/upgrade_guide_console_docs
Add docs for web-console to 4.2 Upgrade Guide
-rw-r--r-- | guides/source/upgrading_ruby_on_rails.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/guides/source/upgrading_ruby_on_rails.md b/guides/source/upgrading_ruby_on_rails.md index 989d8400e5..98faaafc2d 100644 --- a/guides/source/upgrading_ruby_on_rails.md +++ b/guides/source/upgrading_ruby_on_rails.md @@ -8,7 +8,7 @@ This guide provides steps to be followed when you upgrade your applications to a General Advice -------------- -Before attempting to upgrade an existing application, you should be sure you have a good reason to upgrade. You need to balance out several factors: the need for new features, the increasing difficulty of finding support for old code, and your available time and skills, to name a few. +Before attempting to upgrade an existing application, you should be sure you have a good reason to upgrade. You need to balance several factors: the need for new features, the increasing difficulty of finding support for old code, and your available time and skills, to name a few. ### Test Coverage @@ -55,7 +55,11 @@ a [pull request](https://github.com/rails/rails/edit/master/guides/source/upgrad ### Web Console -TODO: setup instructions for web console on existing apps. +First, add `gem 'web-console', '~> 2.0.0.beta3'` to the `:development` group in your Gemfile and run `bundle install` (it won't have been included when you upgraded Rails). Once it's been installed, you can simply drop a reference to the console helper (i.e., `<%= console %>`) into any view you want to enable it for. A console will also be provided on any error page you view in your development environment. + +Additionally, you can tell Rails to automatically mount a VT100-compatible console on a predetermined path by setting `config.web_console.automount = true` in your application.rb. You can specify the path by setting `config.web_console.default_mount_path` (note that this defaults to `/console`). + +TODO: Update `web-console` version to release version. ### Responders |