Ruby65DocPlan

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 NB 65 Doc Plan.


Contents


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 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

Document Media Priority Writer SME Eng Review QE Review Edit Published
Installing and Configuring Ruby Support in the NetBeans IDE Tutorial High Chris Martin/Erno D- Martin Schovanek PJ publish
Getting Started With Ruby and Rails Tutorial High Chris sme eng review qe review edit publish
Creating a Ruby Web Log in 10 Minutes Tutorial High Chris Brian Leonard - Martin Schovanek PJ publish
Using Java Libraries in Rails Applications Tutorial Medium Chris Brian Leonard - Martin Schovanek PJ publish
Putting Flickr on Rails Tutorial Low writer sme eng review qe review edit publish
Building Relationships Between Ruby Models Tutorial High Chris Brian Leonard June 3 Martin Schovanek PJ publish
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.

Document Media Priority Writer SME Eng Review QE Review Edit Published
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

Document Media Priority Writer SME Eng Review QE Review Edit Published
Editing Ruby Code Screencast Low writer sme eng review qe review edit publish
Ruby Hints and Quick Fixes Screencast Low writer sme eng review qe review edit publish
Using Ruby Code Completion Screencast Low writer sme eng review qe review edit publish
Using Live Code Templates Screencast Low writer sme eng review qe review edit publish
Creating a Ruby Web Log in 10 Minutes Screencast Low writer sme eng review qe review edit publish
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
Writing Unit Tests Screencast Low writer sme eng review qe review edit publish
Using the Ruby Debugger Screencast Low writer sme eng review qe review edit publish


Sample Projects

Update readme if necessary.

Document Writer Notes
Depot readme Chris submitted via attachment to bug 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.

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
create_customize_codetemplates.html Chris minor nits n/a
editor_shortcuts_codetemplates.html Chris minor nits n/a
geminstallationdialog.html Chris minor nits Martin
geminstallsettingsdialog.html Chris no changes Martin
gemmanager.html Chris UI changes and cleanup of wording Martin - -
newdbconfig.html Chris no changes Erno - -
newrailsappwiz-installrails.html Chris UI changes Erno
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
railsplugininstallationdialog.html Chris no changes Erno
railspluginmanager.html Chris no changes Erno
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 -
rubyoptions.html Chris Added to TOC and hooked up with help id (143354), turned into topic that covers all Ruby settings in all options panels Tor or Martin -
rubyprojectnode.html Chris Removed all the redundant wording that is in the quickref and instead provided a pointer to the quickref Martin -
rubyprojprops-javaoptions.html Chris minor nits Martin
rubyprojprops-runoptions.html Chris minor nits Martin - -
rubyprojprops-sourcesoptions.html Chris minor nits Martin
usedatabase.html Chris REMOVED Erno - - -
usingirb.html Chris REMOVED Martin
Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo