Bug 498439 - Migrate GEF4 documentation to GitHub wiki (as 5.x documentation)
Summary: Migrate GEF4 documentation to GitHub wiki (as 5.x documentation)
Status: RESOLVED FIXED
Alias: None
Product: GEF
Classification: Tools
Component: Misc (show other bugs)
Version: 1.0.0   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 5.0.0 (Oxygen) M2   Edit
Assignee: Alexander Nyßen CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on: 498552 498584
Blocks: 467060 498421
  Show dependency tree
 
Reported: 2016-07-25 10:25 EDT by Alexander Nyßen CLA
Modified: 2016-08-15 06:45 EDT (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alexander Nyßen CLA 2016-07-25 10:25:31 EDT
While the documentation for the GEF4 maintenance release (4.1.0) can still be maintained at wiki.eclipse.org/GEF/GEF4, we should start building up the 5.x project documentation in the GitHub wiki. As soon as the GEF 4.1.0 (Neon.1) release has been shipped, we can remove the GEF4 wiki pages and point to the GitHub documentation alone (in addition to the web page).
Comment 1 Alexander Nyßen CLA 2016-07-27 10:09:13 EDT
I pushed the following changes to origin/master:

- Replace wikitext task to pull from wiki.eclipse.org (mediawiki) with conversion task that works against offline github wiki (markdown).
- Ensured build does not generate wikidoc per default (as this requires that the wiki is checked out). Provided wiki.base.path option to allow specifying the path to the offline github wiki.
- Include patched wikitext-markdown converter to have code blocks transferred properly (see bug #498552).
Comment 2 Alexander Nyßen CLA 2016-07-28 03:53:24 EDT
Add dependencies to the following wikitext bugs, which are a prerequisite for proper conversion of the documentation:

- bug #498552 (fenced code blocks not supported)
- bug #498584 (inline links not recognized within phrases)
Comment 3 Alexander Nyßen CLA 2016-07-29 01:21:35 EDT
I have bundled a patched version of the wikitext markdown converter that fixes bug #498552 and bug #498584. I will contribute the fixes to wikitext, so we can switch back to an official version. 

At the moment, there are two things that remain here:

1) We need to transfer (and update) all required images
2) We need to fix anchor links to anchors where a '.' is included (it seems the markdown converter produces different anchors to the GibHub renderer).
Comment 4 Matthias Wienand CLA 2016-08-01 10:11:03 EDT
I copied the images to the gef.wiki repository. I also fixed the paths to many images within the .md files. However, not all images are displayed yet.
Comment 5 Matthias Wienand CLA 2016-08-15 06:45:01 EDT
I added the missing pages and images, and fixed the links, so that the GitHub Wiki does now contain everything that was previously available at the Eclipse Wiki. Therefore, I resolve this ticket as fixed for 5.0.0 M2.