This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 122809 - Depot sample app needs cleanup work
Summary: Depot sample app needs cleanup work
Status: RESOLVED FIXED
Alias: None
Product: ruby
Classification: Unclassified
Component: Code (show other bugs)
Version: 6.x
Hardware: All All
: P2 blocker (vote)
Assignee: Martin Krauskopf
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-11-26 22:31 UTC by Chris Kutler
Modified: 2008-02-14 13:30 UTC (History)
3 users (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments
Added information about accessing the Admin and REST interface (4.70 KB, text/plain)
2008-01-11 20:24 UTC, Chris Kutler
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Kutler 2007-11-26 22:31:32 UTC
1. login_controller.rb.orig should be removed. It might confuse people as to why
it is there and what to do with it.

2. README should be removed. It has conflicting instructions from the NetBeans perspective and
we really want people to use README-DEPOT.html instead. I know that the README-DEPOT.html
pops up when they first create the project, but when they return to an existing project,
this document is hard to find (it does not appear in the projects window). On the
other hand, the README is very visible in the Projects window. 

Examples of confusing instructions

It tells people to run server script from the command line.

It tells people how to use the script/breakpointer client.

It has bad links, such as "You can read more about Action Pack in 
link:files/vendor/rails/actionpack/README.html."

3. The DEPOT-README needs to add the following information:

To view the Admin pages browse to:



      http://localhost:3000/admin

      and log in using "admin" and "secret" as the name and password.


There's also a REST interface that can be accessed by typing:

http://localhost:3000/info/who_bought/1
http://localhost:3000/info/who_bought/2
http://localhost:3000/info/who_bought/3 

Note: I can modify the readme, but I need to know who to deliver it to
and what my timeline is. For example, I assume this would be too late
for 6.0 FCS.
Comment 1 Tomas Danek 2007-11-27 13:01:52 UTC
i agree sample needs cleanup, anyway not for 6.0 -> too late. However, this needs to be well communicated with Pragm.
programmers, to keep sample legal. John J. was involved in this legal process, IIRC?!
Comment 2 Martin Krauskopf 2008-01-06 18:39:56 UTC
Just saw this issue. Reassigning to me (or actually to John)

Chris all I need is just new version of DEPOT-README.html (or patch, up to you). Then I will apply it to the trunk.
Otherwise I agree with everything you proposed. But I need confirmation from John that everything is OK legally with
regard to Pragmatics Programmers.

John, please add your comments and reassign this issue to me if I can proceed with changes. Thanks. (I believe that you
are the person in charge wrt. to the Depot sample vs. our own customization of the sample).
Comment 3 Chris Kutler 2008-01-07 16:06:07 UTC
John, I expect that you will ask me to update the readme. Please let me know where the current version resides so that I
can update it.
Comment 4 Martin Krauskopf 2008-01-07 18:30:24 UTC
Chris, it reside in the .zip in NetBeans CVS:

   ruby/samples/depot-sample/external/DepotProject.zip#uzip/README-DEPOT.html

It's enough if you just send me a diff or new version and I'll apply it. Or just create a new Depot sample, edit the
README-DEPOT.html and send it to me (or attach it here).
Comment 5 Chris Kutler 2008-01-11 20:24:41 UTC
Created attachment 54973 [details]
Added information about accessing the Admin and REST interface
Comment 6 Martin Krauskopf 2008-02-14 12:36:00 UTC
I've heard we have a go to do whatever changes. Reassigning back.
Comment 7 Martin Krauskopf 2008-02-14 13:30:59 UTC
Fixed. Changes:

- login_controller.rb.orig removed
- applying Chris' README-DEPOT.html patch
- removing README which had conflicting instructions

http://hg.netbeans.org/main?cmd=changeset;node=0c06a6ea892a