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.
Previous Topic
