docs: creating a devworkspace telemetry plug-in

[dkwon17]

Signed-off-by: David Kwon [email protected]

What does this pull request change

Adds a Creating a Telemetry plugin For DevWorkspaces section:

The new content is similar to the Creating a Telemetry plugin section, except that the new content is specific to DevWorkspaces.

This pull request also adds more details to the Telemetry section:

What issues does this pull request fix or reference

eclipse-che/che#20820
eclipse-che/che#20090

Specify the version of the product this pull request applies to

This pull request adds content to the 7.43.x version docs, but this pull request applies to any version that supports devworkspace telemetry, which I believe, should be version 7.27.x and above.

After the PR feedback and after this PR is merged, I would like to make a new PR to add the content of this PR to main, since this content is DevWorkspace-specific.

Pull request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

• Any procedure:
  • Successfully tested.
• Any page or link rename:
  • The page contains a redirection for the previous URL.
  • Propagate the URL change in:
    • Dashboard default branding data
    • Chectl constants.ts
• Builds on Eclipse Che hosted by Red Hat.
• the Validate language on files added or modified step reports no vale warnings.

[github-actions]

Click here to review and test in web IDE:

[ibuziuk]

left a couple of comments

[ibuziuk]

@dkwon17 looks like there is one language suggestion that need to be addressed -
Use 'plug-in' rather than 'plugin'.

[dkwon17]

There is a validation error in the CI here:

This error is referencing this part of the PR:

che-docs/modules/extensions/partials/proc_creating-a-telemetry-plugin-for-devworkspaces.adoc

Lines 69 to 79 in f43bbae

	pass:[<!-- vale RedHat.TermsErrors = NO -->]
	. Maven Quarkus project scaffolding:
	+
	----
	$ mvn io.quarkus:quarkus-maven-plugin:2.7.1.Final:create \
	-DprojectGroupId=mygroup -DprojectArtifactId=devworkspace-telemetry-example-plugin \
	-DprojectVersion=1.0.0-SNAPSHOT
	----
	pass:[<!-- vale RedHat.TermsErrors = YES -->]

Although, I'm not sure how to fix this, since the code is already surrounded by pass:[<!-- vale RedHat.TermsErrors = NO -->] and pass:[<!-- vale RedHat.TermsErrors = YES -->].

Do you have any suggestions @rkratky, @themr0c ?

[max-cx]

@themr0c, is there a way to pass through the contents of a code block so that Vale does not throw an error?

[nickboldt]

you could move the code to a separate file and include it, like on line 43 above?

include::example$creating-a-telemetry-plug-in-for-devworkspaces/main.go[]

[dkwon17]

you could move the code to a separate file and include it, like on line 43 above?

I did this in my latest commit and there's no error on line 74 anymore. Still not completely sure why pass:[<!-- vale RedHat.TermsErrors = NO -->] and pass:[<!-- vale RedHat.TermsErrors = YES -->]. didn't suppress the error before.

I've added the passes in the latter part of the documentation and it is working there.

[ibuziuk]

@themr0c please advise how can we set up the excludes for mvn command

[ibuziuk]

@dkwon17 could you please resolve the conflicts ?

[nickboldt]

@dkwon17 could you please resolve the conflicts ?

Please confirm this is a good conflict fix. I couldn't find an existing doc for customizing workspaces components but did find https://www.eclipse.org/che/docs/che-7/end-user-guide/authoring-devfiles-version-2/ so I have assume @dkwon17 's link is better than what's in master branch sources.

4d2233b

[ibuziuk]

@dkwon17 looks great, added a single formatting update request (no new line for .sh)
@nickboldt @themr0c @max-cx folks, if you do not have any other suggestions, please approve

[max-cx]

We can't write about the future in the docs.

Will removing this first sentence of this warning admonition make a difference to the meaning of the second sentence?

Suggested change

This page explains how to create a back-end telemetry plug-in for {prod-short} workspaces, which will be deprecated in favour of {devworkspace}s.

[dkwon17]

In that case, could this sentence instead be shortened to:

"This page explains how to create a back-end telemetry plug-in for {prod-short} workspaces."

instead?

How does that sound @max-cx @ibuziuk ?

[dkwon17]

This is how it would look like:

[ibuziuk]

looks good ^
In general the plan is to remove non-devworkspace part in the future PRs completely as part of eclipse-che/che#21264 cleanup

[dkwon17]

Thank you for the reviews everyone, I have committed the suggestions.