[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [pdt-dev] PDT Help

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 <zulus@xxxxxxxxx> 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Â

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev