Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 321355

Summary:	Assign wiki documentation page to the task
Product:	z_Archived	Reporter:	oliver.burkhalter <olimination>
Component:	Mylyn	Assignee:	Mylyn Inbox <mylyn-inbox>
Status:	RESOLVED WORKSFORME	QA Contact:
Severity:	enhancement
Priority:	P3	CC:	steffen.pingel
Version:	unspecified
Target Milestone:	---
Hardware:	PC
OS:	Windows 7
Whiteboard:

Description oliver.burkhalter

2010-07-30 10:54:07 EDT

Build Identifier: 20100617-1415

In software development the technical documenation is always something that developers don't like very much. To ease the documentation process, it would be maybe a idea to integrate wiki pages to tasks. That mean: In the task-editor I have the possibility to connect a wiki page(Confluence, MediaWiki, etc.) to the task. In the task I have a section/tab where I can edit the wiki text and submit it again back to the configured wiki page.

I think this could be useful, what do you think?

Reproducible: Always

Comment 1 oliver.burkhalter

2010-07-30 10:57:49 EDT

This could maybe be placed under org.eclipse.mylyn.docs

Comment 2 Steffen Pingel

2010-10-25 12:47:05 EDT

We generally use tasks to document changes and keep other technical documentation directly in the source code which is referenced by the context. Commercial Mylyn extensions also allow tracking of web pages such as Wiki documents in the context which we to edit user documentation.

What kind of documentation where you thinking of?

Comment 3 oliver.burkhalter

2010-11-03 15:44:09 EDT

I think of a higher internal technical documentation or a user documentation for the customer.

That's true that we also have technical documentation at the source level, but we also have technical documentation which includes severals UML diagramms(sequence, class, etc.) and so on which is better documented in a wiki or other format.

An idea would also be to have such documentation also versionized in the VCS in a Latex or wiki format and then we could attach these files to the task context too.

The commercial Mylyn extension sounds great too, where can I find this?

So a "wiki-page integration" for the Mylyn task editor interface is maybe a bit too much...

Comment 4 Steffen Pingel

2010-11-08 05:27:17 EST

You can find a list of extensions on the Wiki, e.g.: http://wiki.eclipse.org/Mylyn/Extensions#Office_Documents_and_Web_Page_.28by_Tasktop.29 

It sound like the technical documentation is a resource in your case and should hence be tracked through the context. That works out of the box if the documentation is stored in the workspace but otherwise I would recommend taking a look at the extensions above.