Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » OSEE » OSEE documentation goes Wiki
OSEE documentation goes Wiki [message #12733] Mon, 20 April 2009 16:48 Go to next message
Donald Dunne is currently offline Donald Dunne
Messages: 192
Registered: July 2009
Senior Member
We are having some of the same issues as some of the other Eclipse
projects in trying to create/maintain documentation in Eclipse Help,
Eclipse Wiki and project website becomes a daunting task. At EclipseCon
this year, we ran across a technology called wikitext where information
maintained at eclipse wiki can be automatically converted into the
Eclipse Help system. The Mylyn project created and uses wikitext for
just this purpose.

We have had a number of discussions and have decided to move in this
direction. It will take some time to convert everything over, but it is
a priority to all of our users and developers.

The start of the OSEE Users Guide can be accessed at
http://wiki.eclipse.org/OSEE
Re: OSEE documentation goes Wiki [message #13456 is a reply to message #12733] Tue, 21 April 2009 12:19 Go to previous message
Donald Dunne is currently offline Donald Dunne
Messages: 192
Registered: July 2009
Senior Member
The benefits of going Wiki are:
1) Ease of editing
2) Ability to auto-generate Eclipse Help from Eclipse Wiki documentation
(see http://en.wikipedia.org/wiki/Wikitext)
3) Eclipse standard for documentation
4) Open and transparent

We have setup our base documentation on our wiki at:
http://wiki.eclipse.org/OSEE (also linked off our eclipse webpages)

Editing wiki is extremely simple. Just log in (top right of any wiki
page) with your bugzilla account and select the "edit" hyperlink next to
the item you want to edit.

Some help for markup can be found at:
http://en.wikipedia.org/wiki/How_to_edit

As always, we're interested in feedback and discussion all.
Re: OSEE documentation goes Wiki [message #572845 is a reply to message #12733] Tue, 21 April 2009 12:19 Go to previous message
Donald Dunne is currently offline Donald Dunne
Messages: 192
Registered: July 2009
Senior Member
The benefits of going Wiki are:
1) Ease of editing
2) Ability to auto-generate Eclipse Help from Eclipse Wiki documentation
(see http://en.wikipedia.org/wiki/Wikitext)
3) Eclipse standard for documentation
4) Open and transparent

We have setup our base documentation on our wiki at:
http://wiki.eclipse.org/OSEE (also linked off our eclipse webpages)

Editing wiki is extremely simple. Just log in (top right of any wiki
page) with your bugzilla account and select the "edit" hyperlink next to
the item you want to edit.

Some help for markup can be found at:
http://en.wikipedia.org/wiki/How_to_edit

As always, we're interested in feedback and discussion all.
Previous Topic:OSEE Quickstart - Tutorial to get you up and running...
Next Topic:How do I create relations?
Goto Forum:
  


Current Time: Tue Sep 02 05:23:10 EDT 2014

Powered by FUDForum. Page generated in 0.02082 seconds