Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 338353 - consider moving the WikiText documentation under Mylyn
Summary: consider moving the WikiText documentation under Mylyn
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: PC Linux
: P3 trivial (vote)
Target Milestone: 1.4.0   Edit
Assignee: Steffen Pingel CLA
QA Contact: David Green CLA
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-02-27 15:06 EST by Steffen Pingel CLA
Modified: 2011-03-02 15:23 EST (History)
1 user (show)

See Also:

Attachments
patch (1.47 KB, patch)
2011-02-27 15:08 EST, Steffen Pingel CLA 		no flags Details | Diff
mylyn/context/zip (1.59 KB, application/octet-stream)
2011-02-27 15:09 EST, Steffen Pingel CLA 		no flags Details
screenshot without Mylyn Tasks (7.61 KB, image/png)
2011-03-01 19:23 EST, Steffen Pingel CLA 		no flags Details
View All 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 Steffen Pingel CLA 2011-02-27 15:06:56 EST 
Bug 337513 introduced a new top-level "Mylyn Documentation" node in the help index. Since WikiText is part of Mylyn it would be nice to make its documentation show under that node.
Comment 1 Steffen Pingel CLA 2011-02-27 15:08:59 EST 
Created attachment 189905 [details]
patch
Comment 2 Steffen Pingel CLA 2011-02-27 15:09:00 EST 
Created attachment 189906 [details]
mylyn/context/zip
Comment 3 Steffen Pingel CLA 2011-02-27 15:09:23 EST 
David, what do you think? Screen shot is on bug 337513.
Comment 4 David Green CLA 2011-03-01 16:46:48 EST 
I'm fine with this, but we should keep in mind that this is reversing a decision that we made before where we had a problem with WikiText documentation being invisible for users that didn't have other Mylyn components installed.  Would it be possible to split out the top-level Mylyn documentation node from other Mylyn documentation components?  Documentation plug-ins for sub-projects could then solve this problem via plug-in dependencies.
Comment 5 Steffen Pingel CLA 2011-03-01 19:23:11 EST 
Created attachment 190103 [details]
screenshot without Mylyn Tasks
Comment 6 Steffen Pingel CLA 2011-03-01 19:25:45 EST 
(In reply to comment #4)
> I'm fine with this, but we should keep in mind that this is reversing a decision
> that we made before where we had a problem with WikiText documentation being
> invisible for users that didn't have other Mylyn components installed.  Would it
> be possible to split out the top-level Mylyn documentation node from other Mylyn
> documentation components?  Documentation plug-ins for sub-projects could then
> solve this problem via plug-in dependencies.

We can consider that but my sense is that Tasks is the best place to put "branding" since it's the root of the feature dependency chain.

WikiText shows in the help index when Mylyn is not available. The only difference is the name of the top-level node which changes to Mylyn WikiText Documentation but you could easily change that. I don't see a way of getting rid of the extra level of nesting though.
Comment 7 David Green CLA 2011-03-02 14:29:59 EST 
looks good to me, go ahead.
Comment 8 Steffen Pingel CLA 2011-03-02 15:23:56 EST 
Thanks. Committed.