January 29, 2006

IntelliJ IDEA: OpenAPI documentation contributions

Arik Kfir asks whether we accept contributions to our OpenAPI documentations. In fact, the best way to contribute to the documentation is to write an overview article covering an area of the OpenAPI that you’re familiar with. The article does not need to be overly long and detailed – simply describe how to use a component, and how to accomplish the most common tasks using its API. We will be happy to review the articles, publish them on jetbrains.com (if you agree to this), and possibly include them in the Plugin Development Package.

JavaDoc contributions are also welcome. However, we can produce JavaDocs pretty fast internally, so it may be sufficient to file a JIRA request specifying the classes that you would like to see documented.

If you would like to write an article covering some part of the OpenAPI, please contact me (yole@jetbrains.com) in advance and let me know about the topics you’re going to cover, so that we can avoid work duplication. Also, a new introductory plugin development tutorial will be published with the 5.1 release, so articles covering the very basics of plugin development are not in the highest demand now.

And thanks for your offer to contribute, Arik!

Posted by Dmitry Jemerov at January 29, 2006 10:00 PM

Sorry for not seeing this comment earlier...;-)

Glad to hear this - we are starting to work on a plugin to integrate Maven 2.0 - when we finish, I'll be happy to provide a complete list of every class whose javadoc would have been useful (I'll put it in JIRA).

As for articles - I'll try to summarize some experience I will acquire through writing the plugin (for example, we might want to create a custom project/module model that's based on maven's pom.xml instead of the ipr/iws/etc - not much material on that right now I think) and we will probably do some j2ee integration, so I'll try writing on that too!

I'll probably have some stuff to contribute in the coming months when we start coding the plugin.


Posted by: Arik Kfir at May 8, 2006 12:11 AM
Post a comment

Remember personal info?