Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide documentation for enabling DevWorkspace telemetry and update existing docs #20820

Closed
Tracked by #21254
dkwon17 opened this issue Nov 24, 2021 · 1 comment
Closed
Tracked by #21254
Labels
area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/next

Comments

@dkwon17
Copy link
Contributor

dkwon17 commented Nov 24, 2021

Is your task related to a problem? Please describe

There is documentation for enabling telemetry and developing a telemetry plugin for workspaces created from the Che-server engine, but none for DevWorkspaces.

Describe the solution you'd like

After #20090 is complete, it would be great if the creating a telemetry plugin section from the docs was updated to explain how to integrate a telemetry plugin to work with DevWorkspaces.

In addition, it would be great if:

  • the existing docs were updated to include a sample telemetry plugin GitHub project. The docs provide a sample implementation for the abstract methods, but not a full project example. This would help bring more clarity to the docs, for both DevWorkspace telemetry and Che-server workspace telemetry.
  • this section is updated to provide more details for packaging the plugin

Describe alternatives you've considered

No response

Additional context

No response

@dkwon17 dkwon17 added kind/task Internal things, technical debt, and to-do tasks to be performed. area/doc Issues related to documentation severity/P1 Has a major impact to usage or development of the system. labels Nov 24, 2021
@ibuziuk ibuziuk mentioned this issue Feb 22, 2022
24 tasks
@ibuziuk ibuziuk mentioned this issue Mar 14, 2022
35 tasks
@ibuziuk
Copy link
Member

ibuziuk commented Mar 15, 2022

The issue can be closed once eclipse-che/che-docs#2231 is merged

@ibuziuk ibuziuk closed this as completed Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues related to documentation kind/task Internal things, technical debt, and to-do tasks to be performed. severity/P1 Has a major impact to usage or development of the system. sprint/next
Projects
None yet
Development

No branches or pull requests

2 participants