Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 109897 - [109892.4] Divide the online help into documentation for users and documentation for consumers
Summary: [109892.4] Divide the online help into documentation for users and documentat...
Status: CLOSED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: TPTP (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows 2000
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Ruth Lee CLA
QA Contact:
URL: http://eclipse.org/tptp/groups/Archit...
Whiteboard: closed460
Keywords:
Depends on: 125392
Blocks: 109892
  Show dependency tree
 
Reported: 2005-09-19 11:48 EDT by Ruth Lee CLA
Modified: 2016-05-05 11:19 EDT (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Ruth Lee CLA 2005-09-19 11:48:41 EDT 
The Foundation has asked TPTP to divide its online help into two categories: doc
for users (developers who use TPTP to test & profile) and doc for consumers
(extenders of TPTP). Both types of documentation remain in the plug-in format,
but the consumer documentation should be shipped only in the SDK. The user
documentation should remain in the binary production driver of TPTP.

The org.eclipse.platform/jdt plug-ins have chosen a naming convention of
"doc.user" and "doc.isv". 

This enhancement is for the Project to analyze its online help documentation,
categorize it according to its target audience, and refactor the documentation
into two plug-ins.
Comment 1 Christophe Telep CLA 2005-12-09 10:45:58 EST 
proposed to be planned for 4.2 but no resources are available (helpwanted
keyword added)
Comment 2 Christophe Telep CLA 2005-12-09 12:19:02 EST 
Target set to 4.2
Comment 3 Ruth Lee CLA 2006-01-26 16:52:14 EST 
Investigation shows that there is no existing trace doc user plug-in (it's all in platform), hence there is no work for the Trace.Doc component. Closing.
Comment 4 Ruth Lee CLA 2006-03-01 10:40:53 EST 
Reopening based on feedback. It has been requested that the following examples be removed from the monitoring project and into the trace project:
   - Column Extension Sample
   - Context Language
   - Export Viewer Generator
   - Filter Type Sample
This means that a "trace.doc.isv" plug-in and a "trace.examples.isv" plug-in need to be created in the trace project, and that the ISV features will need to be updated to include them. I suspect that this means that we might need a new trace feature?
Comment 5 Eugene Chan CLA 2006-03-02 10:59:46 EST 
Ruth, 

After reviewing with Dave, the following 3 should be considered a platform isv example

   - Context Language
   - Export Viewer Generator
   - Filter Type Sample

Only the - Column Extension Sample - fits under trace isv example.

Thanks
Comment 6 Ruth Lee CLA 2006-03-09 15:55:44 EST 
Two new plug-ins, org.eclipse.tptp.trace.doc.isv and org.eclipse.tptp.trace.examples.isv have been created. The other three examples were moved to platform ISV as discussed.
Comment 7 Ruth Lee CLA 2006-03-27 16:07:36 EST 
Reopening for the refactoring of the test suites.
Comment 8 Ruth Lee CLA 2006-03-27 16:33:33 EST 
Done.
Comment 9 Hubert Leung CLA 2007-05-10 17:11:02 EDT 
Moving bugs from Trace.Doc to Platform.Doc because Trace.Doc will be removed.
Comment 10 Paul Slauenwhite CLA 2009-06-30 09:49:49 EDT 
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant enhancements/defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this enhancement/defect is verified/closed by the Project Lead since this originator of this enhancement/defect has an inactive Bugzilla account and considered to be fixed. If this enhancement/defect is still unresolved and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.
Comment 11 Paul Slauenwhite CLA 2009-06-30 09:52:21 EDT 
As of TPTP 4.6.0, TPTP is in maintenance mode and focusing on improving quality by resolving relevant enhancements/defects and increasing test coverage through test creation, automation, Build Verification Tests (BVTs), and expanded run-time execution. As part of the TPTP Bugzilla housecleaning process (see http://wiki.eclipse.org/Bugzilla_Housecleaning_Processes), this enhancement/defect is verified/closed by the Project Lead since this originator of this enhancement/defect has an inactive Bugzilla account and considered to be fixed. If this enhancement/defect is still unresolved and reproducible in the latest TPTP release (http://www.eclipse.org/tptp/home/downloads/), please re-open.