[che-docs] Automatically generate documentation with the list of supported plugins after each Che release
See original GitHub issueIs your task related to a problem? Please describe.
The issue is inspired by https://github.com/eclipse/che-docs/pull/1041 Currently, it is not straight forward to get information about supported plugins, languages, debuggers supported in Che. This info is located in the che-plugin-registry - https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins and currently docs do not contain any information about the supported plugins.
Describe the solution you’d like / User Stories
- As a user, I want to have up-to-date information about the supported plugins
- As a developer, I want to have the adoc with supported plugins automatically generated
Describe alternatives you’ve considered
Manual creation of the doc which is error-prone and get obsolete really fast
Additional context
Potential implementation details
- adoc is generated from the https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins
- meta.yaml for each plugin has a relevant
category
e.g. Language / Debugger
Issue Analytics
- State:
- Created 4 years ago
- Comments:9 (9 by maintainers)
Top Results From Across the Web
Introduction to Eclipse Che :: Eclipse Che Documentation
Che -Theia plugins rely on APIs compatible with Visual Studio Code. Plug-ins are isolated and provide their own dependencies packaged in containers.
Read more >Automatic documentation generation from code
Reusing signatures and docstrings with autodoc¶. To use autodoc, first add it to the list of enabled extensions: docs/source/conf.py ...
Read more >End-user Guide Red Hat CodeReady Workspaces 2.15
Red Hat Developer Group Documentation Team devtools-docs@redhat.com ... In the Select an Application search field, type workspace to list all workspaces.
Read more >Plugin Documentation - Jenkins
These pages are generated automatically using the metadata from the latest plugin release and an external documentation page. External documentation can be ...
Read more >Devfile v2 and IDE plug-ins - Eclipse Che Blog
When the support is enabled, both Devfile v1 and v2 are supported. You can still work with your previous workspaces and Devfile v1....
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
We have an automated report that lists all plugins in the registry, as well as what version is in the registry and what version is available upstream. The report is updated every time a change is merged.
https://eclipse.github.io/che-plugin-registry/
We can do both!