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

Bug 394137

Summary:	Create Zest 1.x Doc Plugin and remove Zest 1.x documentation from wiki
Product:	[Tools] GEF	Reporter:	Alexander Nyßen <nyssen>
Component:	GEF-Legacy Zest	Assignee:	Alexander Nyßen <nyssen>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3
Version:	unspecified
Target Milestone:	3.9.100 (Luna) M1
Hardware:	All
OS:	All
Whiteboard:
Bug Depends on:	419720
Bug Blocks:

Description Alexander Nyßen

2012-11-12 16:17:10 EST

Up to now, there is no Zest 1.x API reference available, and no reference doc, just a simple overview on the wiki pages. 

While it is not worth to spent effort on building up a new reference documentation for Zest 1.x, we should create a Zest 1.x doc.isv plug-in, which contains the Zest 1.x API reference and the rather sparse Zest 1.x documentation that is currently provided on the wiki page (which can in turn be removed). We should further integrate this new plug-in into the GEF & Draw2d Developer Guide (and rename this one accordingly).

This way, the complete reference documentation for the proper code base, i.e. Draw2d/GEF (MVC) 3.x and Zest 1.x will be consistently provided via the respective doc plug-ins only, while those for the new GEF4 components will be maintained in the wiki (and extracted via Mylyn Wikitext).

This will help us to further clean up our wiki pages and to provide a clearer distinction between the proper development stream and the new GEF4 development branch to our users.

Comment 1 Alexander Nyßen

2012-11-12 16:58:52 EST

Performed the following changes (pushed all changes to origin/master):

- Created org.eclipse.zest.doc.isv plug-in, which provides API reference
and a very small guide document, containing the information extracted
from the Zest 1.x wiki page
(http://wiki.eclipse.org/GEF_Zest_Visualization)
- Renamed the "GEF & Draw2d Plug-in Developers Guide" to "GEF Developers
Guide" and integrated the Zest API reference and guide via anchors.
- Added the org.eclipse.zest.doc.isv plug-in to the Zest SDK feature.
- Integrated the org.eclipse.zest.doc.isv plug-in into the relent
pom.xml.
- Ensured that all documentation plug-ins use the consistent naming of
Draw2d, GEF (MVC), and Zest when referring to the individual components
- Cleaned up overview page of Draw2d documentation plug-in.
- Removed unused topics_Samplex.toc from GEF documentation plug-in.

I also updated the reference documentation wiki page (http://wiki.eclipse.org/GEF/Reference_Documentation) accordingly. 

What remains to be done is to remove the old wiki pages related to Zest 1.x (i.e. http://wiki.eclipse.org/GEF_Zest_Visualization and the images referenced by it).

Comment 2 Alexander Nyßen

2013-10-17 09:45:11 EDT

Unset target milestone as the specified one is already passed.

Comment 3 Alexander Nyßen

2013-10-17 10:21:59 EDT

Created bug #419720 to keep track of the remaining wiki page deletion. If this is completed, the reference documentation of Draw2d and GEF 3.x as well as Zest 1.x is all statically contained in the respective doc.isv bundles, while the GEF4 documentation (including Zest 2.x) will be found in the wiki.

Comment 4 Alexander Nyßen

2013-10-17 11:34:13 EDT

Due to webmaster's comment in bug #419720, instead of removing the GEF_Zest_Visualization wiki page, I changed it to redirect to the GEF wiki main page. Resolving this as fixed.