I am used to both Markdown and Wikitext. Kaloyan
On Mon, Sep 29, 2014 at 6:11 PM, Dawid Pakuła <zu...@w3des.net> wrote: > Hi, > > others agree to option 2? > > What format you prefer? Markdown/Textile/Wikitext/Creole? > My favourite is a markdown [1], very popular now. Wikitext have builtin > editor with preview since last year. > > [1] - http://daringfireball.net/projects/markdown/syntax > > -- > Dawid Pakuła > +48 795 996 064 > > On 29 września 2014 at 09:24:36, Kaloyan Raev (kaloya...@zend.com) wrote: > > Hi Dawid, > > I completely agree that the PDT Help must be improved in the direction you > suggest. > > Let's try option 2 as you suggest. I like the idea of having source and > documentation together. We can build the habit of enforcing documentation > updates when reviewing patches in Gerrit. > > Greetings, > Kaloyan > > On Sat, Sep 27, 2014 at 2:47 PM, Dawid Pakuła <zu...@w3des.net> wrote: > >> Hi team, >> >> At begin, I was officially approved as new project lead. Thank you for a >> trust! >> >> From my side, I want introduce process of incremental cleaning up code >> and documentation. At first, it could be PDT User Manual. >> >> In past, we receive initial documentation from Zend Company (thank you >> for that). Unfortunately this documentation is now outdated and >> unmaintainable. Besides it’s also available in online mode only [1]. >> >> Would be good to convert it into more developer familiar format, update >> and move to org.eclipse.php.help plugin again. This also allow us to >> participate in eclipse info center [2]. Of course good documentation have >> also many other advantages. >> >> I have serveral propositions how we can do that: >> >> 1. Convert to eclipse wiki page, and compile to eclipse help on demand >> or while mvn clean install. Like Mylyn and Egit [3] >> advantages: >> * help can be updated by our user >> * webinterface >> disadvantages: >> * we haven’t full control on help >> * after each ui change, we have to remember about help update. >> Probably everybody forgot >> >> 2. Convert to creole wikitext / textile and put source directly inside >> help plugin repo. Like Xtext [3][4] >> advantages: >> * we can update help and source code in one patch >> * full control on help >> * gerrit :D >> disadvantages: >> * users need CLA signed to send contribution >> >> 3. Only cleanup html code and put to help plugin >> advantages: >> * probably everybody know HTML >> * same advantages as point 2 >> disadvantages: >> * more boilerplate code, probably unreadable without html editor + >> preview >> * same as point 2 >> >> 4. Ignore me ;) >> >> My favourite is point 2. Our format can be Markdown, WikiText, Creole, >> Textile. >> >> [1] - https://bugs.eclipse.org/bugs/show_bug.cgi?id=369635 >> [2] - https://help.eclipse.org/luna >> [3] - https://wiki.eclipse.org/DocumentationGuidelines/Example >> [4] - >> http://git.eclipse.org/c/tmf/org.eclipse.xtext.git/tree/docs/org.eclipse.xtext.doc.xdoc/xdoc >> >> -- >> Dawid Pakuła >> +48 795 996 064 >> >> _______________________________________________ >> pdt-dev mailing list >> pdt-dev@eclipse.org >> To change your delivery options, retrieve your password, or unsubscribe >> from this list, visit >> https://dev.eclipse.org/mailman/listinfo/pdt-dev >> > > _______________________________________________ > pdt-dev mailing list > pdt-dev@eclipse.org > To change your delivery options, retrieve your password, or unsubscribe > from this list, visit > https://dev.eclipse.org/mailman/listinfo/pdt-dev > > > _______________________________________________ > pdt-dev mailing list > pdt-dev@eclipse.org > To change your delivery options, retrieve your password, or unsubscribe > from this list, visit > https://dev.eclipse.org/mailman/listinfo/pdt-dev >
_______________________________________________ pdt-dev mailing list pdt-dev@eclipse.org To change your delivery options, retrieve your password, or unsubscribe from this list, visit https://dev.eclipse.org/mailman/listinfo/pdt-dev
