Installation Documentation Clarification

Jonesjd - August 7, 2009 - 15:37
Project:jQuery UI
Version:6.x-1.3
Component:Documentation
Category:task
Priority:normal
Assigned:Unassigned
Status:closed
Description

At the risk of raising the ire of those of you working hard on this project (this has been addressed eliptically in other places, but the documentation is just not clear), the instructions for installing the "development package" should be reworded. The instructions contained in the readme file and elsewhere read:

* Download the latest jQuery UI 1.6 development package from:

http://code.google.com/p/jquery-ui/downloads/list?can=3&q=1.6

* Extract it as a sub-directory called 'jquery.ui' in the jquery_ui folder etc.

This should probably be reworded something like:

Download the latest release of JQuery UI 1.6 from...etc.
Extract this package, then find the "development-bundle" folder contained within this package, copy it, past it into the jquery_ui folder and rename it "jquery.ui".


Providing something like this wording, will dramatically improve the experience of those trying to install the package. As has been the case with others, it took me quite a while to sort out what the instructions, as currently worded, really mean. Left with the ambiguity of the corrent instructions, most people will go with the Drupal convention, extracting the package, and then pasting the main folder as jquery.ui into the jquery_ui directory. And this, of course, doesn't work. The instructions need to state that it is the "development-bundle" folder found in the 1.6 package that must be renamed "jquery.ui".

Much thanks for your consideration. Hope this helps.

d.

#1

joachim - August 7, 2009 - 16:16

I don't see a "development-bundle" folder in that download.
The instructions seem ok, though I agree this sort of procedure is always fiddly.

#2

sun - August 7, 2009 - 17:03
Status:active» fixed

Thanks for reporting, reviewing, and testing! Committed attached patch to all branches.

A new development snapshot will be available within the next 12 hours. This improvement will be available in the next official release.

AttachmentSize
jquery_ui-DRUPAL-6--1.instructions.patch 1.94 KB

#3

System Message - August 21, 2009 - 17:10
Status:fixed» closed

Automatically closed -- issue fixed for 2 weeks with no activity.

 
 

Drupal is a registered trademark of Dries Buytaert.