Bug 187607 - Update Workbench doc
Summary: Update Workbench doc
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows NT
: P3 normal (vote)
Target Milestone: 3.3   Edit
Assignee: Kevin McGuire CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on: 189455
Blocks: 189242
  Show dependency tree
 
Reported: 2007-05-17 13:14 EDT by Tod Creasey CLA
Modified: 2007-06-07 14:06 EDT (History)
3 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Tod Creasey CLA 2007-05-17 13:14:33 EDT
org.eclipse.platform.doc.user\gettingStarted\qs-02a.htm
Comment 1 Tod Creasey CLA 2007-05-17 13:21:36 EDT
Also org.eclipse.platform.doc.user\gettingStarted\qs-02b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-02e.htm
Comment 2 Tod Creasey CLA 2007-05-17 13:23:13 EDT
org.eclipse.platform.doc.user\gettingStarted\qs-07a.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07c.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07d.htm
Comment 3 Tod Creasey CLA 2007-05-17 15:12:42 EDT
org.eclipse.platform.doc.user\gettingStarted\qs-12.htm
org.eclipse.platform.doc.user\gettingStarted\qs-12b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-12d.htm
org.eclipse.platform.doc.user\gettingStarted\qs-31b.htm
Comment 4 Tod Creasey CLA 2007-05-17 15:50:09 EDT
org.eclipse.platform.doc.user\gettingStarted\qs-39.htm
org.eclipse.platform.doc.user\gettingStarted\qs-39d.htm
org.eclipse.platform.doc.user\gettingStarted\qs-39f.htm
org.eclipse.platform.doc.user\gettingStarted\qs-43.htm
Comment 5 Tod Creasey CLA 2007-05-17 16:42:41 EDT
org.eclipse.platform.doc.user\tasks\tasks-18.htm
org.eclipse.platform.doc.user\tasks\tasks-1c.htm
Comment 6 Tod Creasey CLA 2007-05-24 11:46:44 EDT
org.eclipse.platform.doc.user\tasks\tasks-46bg.htm
org.eclipse.platform.doc.user\tasks\tasks-48b.htm
org.eclipse.platform.doc.user\tasks\tasks-48.htm
Comment 7 Tod Creasey CLA 2007-05-25 10:13:36 EDT
org.eclipse.platform.doc.user\tips\platform_tips.html
Comment 8 Tod Creasey CLA 2007-05-25 11:20:36 EDT
Kevin could you look at
org.eclipse.platform.doc.user\gettingStarted\qs-02a.htm
org.eclipse.platform.doc.user\gettingStarted\qs-02b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-02e.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07a.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07c.htm
org.eclipse.platform.doc.user\gettingStarted\qs-07d.htm
org.eclipse.platform.doc.user\gettingStarted\qs-12.htm
org.eclipse.platform.doc.user\gettingStarted\qs-12b.htm
org.eclipse.platform.doc.user\gettingStarted\qs-12d.htm
org.eclipse.platform.doc.user\gettingStarted\qs-31b.htm

And Kim could you cover
org.eclipse.platform.doc.user\gettingStarted\qs-39.htm
org.eclipse.platform.doc.user\gettingStarted\qs-39d.htm
org.eclipse.platform.doc.user\gettingStarted\qs-39f.htm
org.eclipse.platform.doc.user\gettingStarted\qs-43.htm
org.eclipse.platform.doc.user\tasks\tasks-18.htm
org.eclipse.platform.doc.user\tasks\tasks-1c.htm
org.eclipse.platform.doc.user\tasks\tasks-46bg.htm
org.eclipse.platform.doc.user\tasks\tasks-48b.htm
org.eclipse.platform.doc.user\tasks\tasks-48.htm
org.eclipse.platform.doc.user\tips\platform_tips.html
Comment 9 Kim Horne CLA 2007-05-25 13:21:08 EDT
The getting started tutorial still uses the resource perspective.  This is no longer the default.  Should we switch to the Java perspective?  For our sake I'm voting for keeping with the resource perspective.  :)
Comment 10 Kevin McGuire CLA 2007-05-25 17:56:11 EDT
Yes keep to resource perspective.
Comment 11 Kevin McGuire CLA 2007-05-25 17:57:23 EDT
Note the copyrights are out of date, eg:

<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >

1. Last date is 2005
2. The wording around "LEGAL in the documentation book" is odd, should be EPL non?
Comment 12 Kevin McGuire CLA 2007-05-25 18:46:14 EDT
Tod, I noticed that the file list is missing xhtml files, such as 

org.eclipse.platform.doc.user\gettingStarted\qs-02d.xhtml
Comment 13 Kevin McGuire CLA 2007-05-25 18:49:52 EDT
I've created bug #189242 to track my portion of the list from comment #8.
Comment 14 Tod Creasey CLA 2007-05-28 08:26:09 EDT
Just a coincidence - all of th xhtml files were up to date.

We should do a general copyright pass and check with Karice if there are any updates required.
Comment 15 Kim Horne CLA 2007-05-28 13:13:44 EDT
We should also do a general pass on the string Navigator and update the doc to Project Explorer wherever possible.  
Comment 16 Kevin McGuire CLA 2007-05-29 11:18:53 EDT
Karice, please see comments #11 and #14.  What should the copyrights read?
Comment 17 Karice McIntyre CLA 2007-05-29 12:42:36 EDT
If you are looking for the standard template here is the link: http://www.eclipse.org/legal/copyrightandlicensenotice.php
Comment 18 Kevin McGuire CLA 2007-05-29 13:14:43 EDT
Its for embedding in the html of doc.  I suppose we could munge that copyright so we can embed it in a html unless you've seen a doc/tag form of it already.
Comment 19 Kevin McGuire CLA 2007-05-29 13:20:01 EDT
One point of curiosity is that in 2005 we updated the copyright date but left a rather antiquated (IBM'ish) copyright notice.  I assume it was just an oversight?
Comment 20 Karice McIntyre CLA 2007-05-29 14:03:23 EDT
Well, IBM is the primary contributor of the content so it's ok to state as much in the copyright. 

Bjorn, does the foundation have a policy on the content of the copyright/license notice for headers in HTML files?  The template EPL notice and copyright is too lengthy.
Comment 21 Kevin McGuire CLA 2007-05-29 14:24:27 EDT
Thanks Karice.

Yeah, it was the line " For full details see the LEGAL
in the documentation book that contains this page." that I thought was antiquated, looked like an IBM template.

And yes my other concern was that the EPL java notice looks too long for just the help doc.  In any case it would be good if there was a doc friendly sanctioned template at eclipse.org.
Comment 22 Bjorn Freeman-Benson CLA 2007-05-30 01:39:19 EDT
(In reply to comment #20)
> Bjorn, does the foundation have a policy on the content of the
> copyright/license notice for headers in HTML files?  The template EPL notice
> and copyright is too lengthy.

Not at this time. It's a good idea, though, but (very) unlikely to happen pre-Europa.
Comment 23 Kevin McGuire CLA 2007-06-07 10:55:33 EDT
Changes have been committed but question on copyrights is still unresolved. 
In the absence of a definitive answer for copyright notice for doc, closing this bug.  

I've opened separate bugs to track the copyright issue:
1. platform/UI work: bug #191489
2. request for copyright to eclipse/community: bug #191491
Comment 24 Kevin McGuire CLA 2007-06-07 14:06:07 EDT
Verified in I0607-010

I noticed though that a page was missing from this bug, now filed as bug #191529.