Re: [winery-dev] Documentation

[Steffen Pingel <steffen.pingel@xxxxxxxxxxx>]

Hi,

we mostly use the Eclipse.org Wiki for documentation and text(ile) files in other places. I have found https://www.draw.io helpful for diagrams but I don't have a particular recommendation. Markdown with exported pictures sounds like a good idea. We have always tried to make image sources available as well so others can modify images later.

Steffen

On Tue, Dec 10, 2013 at 12:40 AM, Oliver Kopp <kopp.dev@xxxxxxxxx> wrote:

Dear mentors,

I'm thinking about the software documentation of winery (the design document).

Currently, some documentation is in a privatly hosted DokuWiki
instance. That wiki supports PlantUML which is used for sequence
diagrams in Winery.

Although I like editors such as http://www.aloha-editor.org/ more than
Wiki editors, I am not aware of any (usable) multi-page Wiki/CMS
system supporting that inplace editing. Oh, I saw that now Typo3 is
linked at the Alohapage. And via CreateJS, many CMS seem to be
supported... Mhh... O:-)

I thought, the Eclipse wiki is a good place for documentation,
therefore I opened
https://bugs.eclipse.org/bugs/show_bug.cgi?id=415867.

Do you think, I should follow that way or should I switch to other
ways of documentation? Maybe pure Markdown files with referenced
pictures generated by PlantUML?

WDYT?

Cheers,

Oliver
_______________________________________________
winery-dev mailing list
winery-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/winery-dev

--
Steffen Pingel
Principal Software Engineer, Eclipse Mylyn
Mylyn Tasks Lead
http://tasktop.com