View source

You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in the group: Users.
You can view and copy the source of this page:
==Documentation Plan for NetBeans 6.5 Ruby Support==

This document provides information about the tutorials, screencasts, and online help that are planned for the FCS releases of NB 6.5 Ruby support.

For the overall documentation plan for the Beta and FCS releases of NB 6.5 FCS, see the [[NB65DocPlan | NB 65 Doc Plan]].


__TOC__


===Introduction===

This plan describes the documentation deliverables for Ruby Applications. The documentation objectives are to provide clear, concise, technically accurate, and easily accessible information about using NetBeans . If there are dependencies on other functional teams, such as Engineering, QA, Marketing and the component products documentation teams, those are also listed in this document.
 
===Dependencies===
* All features must be complete enough to accurately document.
* The UI must be stable for step-by-step documentation accuracy.
* The quality of documentation will benefit considerably from QE and technical feedback.

===Analysis and Research===

====6.5 UI and Behavioural Changes====

For details see [[RubyRecentChanges | Ruby Recent Changes]]. Highlights are:

* No Ruby panel in Options window. Ruby options are not interspersed.
* New Run/Debug Rake Task action and dialog box
* Support for Warbler instead of Goldspike
* Additional debugging support: exception & conditional breakpoints
* New options in Settings tab of Gems Manager
* Gems manager will call gksu and kdesu if doesn't have permissions
* Updated to Rails 2.1 which means that the migration files with have different prefixes (timestamp)
* Mark Occurrences Ctrl-Up and Ctrl-Down
* New Test Runner
* Rubinius support
* Support for script/destroy
* Ability to set the rails version at project creation

===Documentation Deliverables===

====Tutorials====


{| border=1 class="simple"
! Document 
! Media
! Priority
! Writer
! SME 
! Eng Review 
! QE Review 
! Edit  
!Published
|- 
| [http://www.netbeans.org/kb/61/ruby/setting-up.html Installing and Configuring Ruby Support in the NetBeans IDE]
|  Tutorial
|  High
| Chris
| Martin/Erno 
| D- 
| Martin Schovanek
|  PJ
| publish
|- 
| [http://www.netbeans.org/kb/61/ruby/getting-started.html Getting Started With Ruby and Rails] 
|  Tutorial
|  High
|  Chris
|  sme 
| eng review 
| qe review
|  edit 
| publish
|- 
| [http://www.netbeans.org/kb/61/ruby/rapid-ruby-weblog.html Creating a Ruby Web Log in 10 Minutes]
|  Tutorial
|  High
|  Chris
| Brian Leonard
|  -
| Martin Schovanek
|  PJ 
| publish
|- 
| [http://www.netbeans.org/kb/61/ruby/java-ruby.html Using Java Libraries in Rails Applications]
|  Tutorial 
|  Medium
| Chris
| Brian Leonard
| -
| Martin Schovanek
| PJ
| publish
|- 
| [http://www.netbeans.org/kb/60/ruby/flickr-on-rails.html Putting Flickr on Rails] 
| Tutorial
|  Low
| writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
| [http://www.netbeans.org/kb/61/ruby/model.html Building Relationships Between Ruby Models]
|  Tutorial
|  High
| Chris
| Brian Leonard 
| June 3 
| Martin Schovanek
|  PJ
| publish
|- 
| [http://www.netbeans.org/kb/60/ruby/ajax.html Using Ajax With NetBeans Ruby]
| Tutorial
|  High
| Chris
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  Integrating Java and Ruby
| Tutorial (rewrite)
|  Low
| writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  Testing the Ruby Weblog Project (new) 
| Tutorial
|  Low
| writer 
|  Brian
|  eng review
| qe review 
| edit
| publish
|- 
|  JRuby and Glassfish (new) 
| Tutorial
|  Low
| writer
|  Arun
| eng review
| qe review  
|  edit 
|  publish
|- 
|  jmaki and Ruby 
| Tutorial
|  Low
| Chris 
|  Brian
|  eng review
| qe review 
| edit
| publish
|}


====Articles====

We do not currently have resources for updating articles. There are no plans for updating articles.

{| border=1 class="simple"
! Document 
! Media
! Priority
! Writer
! SME 
! Eng Review 
! QE Review 
! Edit 
! Published
|- 
|  [http://www.netbeans.org/kb/60/ruby/unittest.html Test-Driven Rails Development] 
| Article
|  Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|}




====Screencasts====


We no longer have resources available for screencasts. These will be upgraded to 6.5 as resources become available.

ToDo: Evaluate which of these screencasts, if any, are still appropriate for 6.5

{| border=1 class="simple"
! Document 
! Media
! Priority
! Writer
! SME 
! Eng Review 
! QE Review 
! Edit 
! Published
|- 
| [http://www.netbeans.org/download/flash/jruby_editing/jruby_editing.html Editing Ruby Code]
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  [http://netbeans.tv/technologies/Tor-Norbye-uses-hints-and-quick-fixes-in-NetBeans-Ruby-Editor-170/ Ruby Hints and Quick Fixes]
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  [http://netbeans.tv/technologies/Tor-Norbye-uses-NetBeans-Ruby-Editor-Code-Completion-169/ Using Ruby Code Completion] 
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
| [http://www.netbeans.tv/screencasts/Tor-Norbye-Uses-Live-Code-Templates-in-the-NetBeans-Ruby-Support-256/ Using Live Code Templates]
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
| [http://www.netbeans.tv/screencasts/Tor-Norbye-Uses-NetBeans-Ruby-Support-to-Create-a-Weblog-231/ Creating a Ruby Web Log in 10 Minutes]
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  [http://netbeans.tv/interviews/Tor-Norbye-mixes-Ruby-and-Java-development-using-NetBeans-151/ Integrating Java and Ruby] 
|  Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  Using Rspec Featuring Nick Sieger 
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  [http://www.netbeans.tv/screencasts/Tor-Norbye-Writes-Unit-Tests-Using-the-NetBeans-Ruby-Support-246/ Writing Unit Tests] 
| Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|- 
|  [http://www.netbeans.tv/technologies/Roman-Strobl-Demonstrates-the-NetBeans-Ruby-Debugger-193/ Using the Ruby Debugger] 
|  Screencast
| Low
|  writer
| sme 
| eng review 
| qe review
|  edit 
| publish
|}


====Sample Projects====

Update readme if necessary.

{| border=1 class="simple"
! Document 
! Writer 
! Notes 
|- 
|  Depot readme 
|  Chris
|  submitted via attachment to bug [http://www.netbeans.org/issues/show_bug.cgi?id=143651 143651] on 8/12
|}



====Online Help====

Upgrade existing Ruby online help for 6.5. This includes updating help topics to reflect UI changes. Reduce and minimize as much as possible.

{| border=1 class="simple"
! Document 
! Writer 
! Notes 
! SME 
! Eng Review 
! QE 
! QE Review
|- 
|  about_ruby 
|  Chris
|  Remove outside links, add info about GF and Rake Runner, IRB action moved to project pop-up
| Martin
|  
| colspan=2| 
|- 
|  create_customize_codetemplates.html 
|  Chris
|  minor nits 
| n/a
|  
| colspan=2| 
|- 
|  editor_shortcuts_codetemplates.html 
|  Chris
|  minor nits  
| n/a
|  
| colspan=2| 
|- 
|  geminstallationdialog.html 
|  Chris
|  minor nits  
| Martin
|  
| colspan=2| 
|- 
|  geminstallsettingsdialog.html 
|  Chris
|  no changes  
| Martin
|  
| colspan=2| 
|- 
|  gemmanager.html 
|  Chris
|  UI changes and cleanup of wording 
| Martin
|  
|  -
|  -
|- 
|  newdbconfig.html 
|  Chris
|  no changes 
| Erno
|  -
| colspan=2| -
|- 
|  newrailsappwiz-installrails.html 
|  Chris
|  UI changes 
| Erno
|  
| colspan=2| 
|- 
|  newrailsappwiz-nameandloc.html 
|  Chris
|  UI changes 
| Erno
|  
|  -
|  -
|- 
|  newrailsappwsourcewiz-nameandloc.html 
|  Chris
|  UI changes 
| Erno
|  
|  -
|  -
|- 
|  newrubyappwiz-nameandloc.html 
|  Chris
|  minor - no main proj 
| Martin
|  
|  -
| -
|- 
|  newrubyappwsourcewiz-nameandloc.html 
|  Chris
|  - no main proj 
| Martin
|  
|  -
|  -
|- 
|  newrubyappwsourcewiz-srcfiles.html 
|  Chris
|   minor nits  
| Martin
|  
|  -
|  -
|- 
|  platformmanager.html
|  Chris
| no changes 
| Martin
|  
|  -
|  -
|- 
|  plugininstallsettingsdialog.html 
|  Chris
| no changes
| Erno
|  
| colspan=2| 
|- 
|  railsplugininstallationdialog.html 
|  Chris
|  no changes 
| Erno
|  
| colspan=2| 
|- 
|  railspluginmanager.html 
|  Chris
|  no changes
| Erno
|  
| colspan=2| 
|- 
|  railsprojprops-railsoptions.html
|  Chris
|  Enhanced server port description and cleaned up wording about configs
| Erno
|  
|  -
|  -
|- 
|  ruby_quickref.html 
|  Chris
| no main proj, remove external links, server configured on project basis, debugger menu change, rake runner addition, irb action moved to project menu
| Martin
|   
| colspan=2| -
|- 
|  rubyoptions.html
|  Chris
| Added to TOC and hooked up with help id ([http://www.netbeans.org/issues/show_bug.cgi?id=143354 143354]), turned into topic that covers all Ruby settings in all options panels 
| Tor or Martin
|  
| colspan=2| -
|- 
|  rubyprojectnode.html 
|  Chris
| Removed all the redundant wording that is in the quickref and instead provided a pointer to the quickref
| Martin
|  
| colspan=2| -
|- 
|  rubyprojprops-javaoptions.html 
|  Chris
|  minor nits 
| Martin
|  
| colspan=2| 
|- 
|  rubyprojprops-runoptions.html 
|  Chris
|  minor nits
| Martin
|  
|  -
|  -
|- 
|  rubyprojprops-sourcesoptions.html 
|  Chris
|  minor nits
| Martin
|  
| colspan=2| 
|- 
|  usedatabase.html 
|  Chris
|  REMOVED
| Erno
|  -
|  -
|  -
|- 
|  usingirb.html 
|  Chris
|  REMOVED
| Martin
|  
| colspan=2| 
|}
Return to Ruby65DocPlan.
Retrieved from "http://wiki.netbeans.org/Ruby65DocPlan"
View source

NetBeans Wiki

Navigation

Toolbox

Views

NetBeans.org
