Eclipse Cloud DevTools Contributor Award: Documentation for Eclipse Theia and Eclipse GLSP

Tuesday, March 29, 2022 - 10:20 by John Kellerman

The Eclipse Cloud DevTools contributor award this month goes to STMicroelectronics for significantly contributing to improving the documentation of Eclipse Theia and Eclipse GLSP. Congratulations and thanks for your contributions!

Eclipse Theia is the next generation platform for building web-based tools and IDEs. Eclipse GLSP is a framework for building modern, web-based diagram editors, e.g. to be integrated into a Theia-based tool. Both projects are currently getting a lot of momentum and are getting adopted by various key players in the industry. Theia and GLSP are Eclipse open source projects and are driven by a diverse community of contributing companies.

Eclipse Theia Contributors and Adopters

Eclipse Theia Contributors and Adopters

STMicroelectronics recently contributed a substantial enhancement of the documentation assets of both the Eclipse Theia and Eclipse GLSP projects. This includes conceptual documentation and tutorials on the website as well as TypeDoc/JavaDoc for documenting the API of the frameworks.

If you would like to have a look, please see the Eclipse Theia documentation and the Eclipse GLSP documentation.

Eclipse Theia and GLSP Documentation

The documentation web pages for Eclipse GLSP and Eclipse Theia

You will immediately recognize the API documentation improvements when working with Theia or GLSP. While there is always room for improvement, the contribution by STMicroelectronics puts both projects on a level of being very well documented.This is confirmed by an analysis of Eclipse Theia and Eclipse GLSP by

Contributing documentation to an open source project creates high strategic value and has a multiplicative effect.

Existing adopters and contributors are not the only beneficiaries. New adopters are prime beneficiaries of good documentation. High quality documentation lowers the barrier of entry and makes it easier to adopt technologies. Therefore, good documentation attracts more project adopters. With new adopters also comes new contributors, ultimately strengthening the entire open source ecosystem of a project.

Last, but not least, contributions often facilitate follow-up contributions and this applies to documentation as well. Contributors are more likely to extend well-established documentation and will more likely document a new API in a well-documented code base.

Therefore, this contributor award is very well deserved. Thank you STMicroelectronics for this strategic contribution to the Eclipse Cloud DevTools ecosystem!

This Eclipse Cloud DevTools contributor award is sponsored by EclipseSource, providing consulting and implementation services for web-based tools, Eclipse GLSP and Eclipse Theia.