Add documantation how to add support for a new language #746

svor · 2019-07-02T06:51:03Z

Signed-off-by: Valeriy Svydenko [email protected]

What does this PR do?

Describes how to add support for a new language into Eclipse Che.

What issues does this PR fix or reference?

https://github.com/eclipse/che-docs/issues/718

tsmaeder

I like it in general.

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

tsmaeder · 2019-07-10T08:04:42Z

@rkratky @slemeur could you review & merge if appropriate, please?

slemeur · 2019-07-23T06:39:53Z

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

-* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
-* You can also link to other modules or assemblies the user must follow before starting this assembly.
-* Delete the section title and bullets if the assembly has no prerequisites.
+* Install the latest Che-Theia plug-in Yeoman generator by running:


Should it also explain from where to start? Using with stack for example?

Maybe pointing to: https://github.com/eclipse/che-theia/blob/master/CONTRIBUTING.md

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

svor · 2019-07-26T07:43:37Z

@slemeur I've added such information into Additional resources

slemeur · 2019-07-26T11:34:10Z

Thanks @svor. I'd prefer to also get the link in the content directly, this way it will be simpler to the reader and the information will be handy. The reader might not think that the documentation would refered at the end of the page.

svor · 2019-07-26T13:29:20Z

@slemeur I added a reference about how to develop Che-theia plug-in with Yeoman in Prerequisites section.

slemeur

Thanks @svor

sunix · 2019-08-01T15:13:38Z

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

-* You can also link to other modules or assemblies the user must follow before starting this assembly.
-* Delete the section title and bullets if the assembly has no prerequisites.
-
+* Install the latest Che-Theia plug-in Yeoman generator. To do that you need to follow the documentation about link:extending-che.html#bootstrapping-che-theia-plug-in-development-with-yeoman_developing-che-theia-plug-ins[how to develop Che-Theia plug-in with Yeoman.]


Why going through using a theia plugin where few lines bellow we say that the prefered way is with a VSCode ext ?

Because writing VS Code extensions is well documented, we don't need to repeat this here.

sunix · 2019-08-01T15:14:10Z

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

 [discrete]
 == Procedure

-. Start each step with an active verb.
+. Generate a sample by running `yo @theia/plugin`. When prompted, confirm the choices for *Backend plug-in*, *Samples*, and then *Language sample*. This creates a project and a ready-to-use plug-in, which provides support for XML Language Server and can be deployed.


Could we provide a devfile for that ?

rkratky

Thanks for the PR. Suggestions added.

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc

svor · 2019-08-02T12:43:39Z

@rkratky Thanks for suggestions. The PR was updated

sunix · 2019-08-06T16:51:24Z

Any reason why this is done as a Theia plugin and not a VSCode extension ?

src/main/pages/che-7/contributor-guide/proc_adding-support-for-a-new-language.adoc

rkratky · 2019-08-06T18:34:01Z

Theia plugin and not a VSCode extension

@sunix, I'd suggest opening a separate issue (or sending a message to devtools-che) to discuss the intended strategic direction in this regard. This PR doesn't seem like to the right place to decide the overall Che-Theia plug-in vs. VS Code extension question.

sunix · 2019-08-06T20:29:00Z

@rkratky my only point is that, we already had that discussion in April in devtool-che and it was very clear at the time that when we write a extension for the IDE we choose either and in that prefered order if possible:

VSCode extension (with or without sidecar container)
Theia plugin (with or without sidecar container)
Theia extension.

I don't know why we don't follow that on our doc ... these parts of the documentation should guide the community to help us in growing this plugin registry https://github.com/eclipse/che-plugin-registry/tree/master/v3/plugins. As I see, 100% of our plugin are VSCode extension + sidecar container. Talking about Theia plugin is confusing.

Signed-off-by: Valeriy Svydenko <[email protected]>

src/main/pages/che-7/contributor-guide/proc_adding-support-for-a-new-language.adoc

Signed-off-by: Valeriy Svydenko <[email protected]>

according to eclipse-che#764 Signed-off-by: Michal Maléř <[email protected]>

rkratky · 2019-08-07T19:50:13Z

I don't know why we don't follow that on our doc ...

@slemeur, could you please weigh in? Should this doc be reoriented?

sunix · 2019-08-08T09:00:21Z

another point is that this is explaining how to create a theia plugin and build it ... and then ? how would the user try that in Che ? There are few missing important parts: test it locally or package it as a Che plugin with a sidecar containers how to test on a running Che. At least if we don't want to add all these details in here, it should guide the user and provide links to other parts of the documentation that explain how to do it.

To me this documentation is not completed.

sunix · 2019-08-14T09:27:24Z

#746 (comment) @tsmaeder

Because writing VS Code extensions is well documented, we don't need to repeat this here.

Could we just add a link to it and explain how to package it in this doc ? The goal of this doc is to give a guidance to our user how to add support for a new language IN CHE ... the prefered way ... not the way that is not already documented elsewhere ...

slemeur · 2019-08-14T15:38:23Z

LGTM and create an issue with clear requirements on improving this doc.
@sunix can you describe what you expected to be improve in the doc in an issue and link it to this?

svor added the kind/docs label Jul 2, 2019

svor requested review from rkratky and tsmaeder July 2, 2019 06:51

svor requested a review from slemeur as a code owner July 2, 2019 06:51

svor self-assigned this Jul 2, 2019

tsmaeder requested changes Jul 2, 2019

View reviewed changes

tsmaeder mentioned this pull request Jul 9, 2019

Languages Sprint 169 eclipse-che/che#13679

Closed

19 tasks

tsmaeder reviewed Jul 9, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_adding-support-for-a-new-language.adoc Outdated Show resolved Hide resolved

tsmaeder approved these changes Jul 10, 2019

View reviewed changes

slemeur reviewed Jul 23, 2019

View reviewed changes

tsmaeder mentioned this pull request Jul 25, 2019

Languages Sprint 170 eclipse-che/che#14016

Closed

20 tasks

slemeur approved these changes Jul 26, 2019

View reviewed changes

sunix reviewed Aug 1, 2019

View reviewed changes

che-bot added the status/code-review label Aug 1, 2019

rkratky suggested changes Aug 1, 2019

View reviewed changes

svor force-pushed the sv/language branch 2 times, most recently from d2d77d3 to 31f022c Compare August 2, 2019 12:40

rkratky approved these changes Aug 6, 2019

View reviewed changes

rkratky reviewed Aug 6, 2019

View reviewed changes

src/main/pages/che-7/contributor-guide/proc_adding-support-for-a-new-language.adoc Outdated Show resolved Hide resolved

Add documantation how to add support for a new language

2c9b913

Signed-off-by: Valeriy Svydenko <[email protected]>

svor force-pushed the sv/language branch from 40271fb to 2c9b913 Compare August 7, 2019 06:19

MichalMaler reviewed Aug 7, 2019

View reviewed changes

src/main/pages/che-7/contributor-guide/proc_adding-support-for-a-new-language.adoc Show resolved Hide resolved

Fix remarks

0c8ea74

Signed-off-by: Valeriy Svydenko <[email protected]>

MichalMaler added a commit to MichalMaler/che-docs that referenced this pull request Aug 7, 2019

Include new topic from eclipse-che#746 in the docs structure

3c327a0

according to eclipse-che#764 Signed-off-by: Michal Maléř <[email protected]>

MichalMaler mentioned this pull request Aug 7, 2019

Adding support for a new language - Sidebar menu #774

Merged

tsmaeder mentioned this pull request Aug 14, 2019

Languages Sprint 171 eclipse-che/che#14221

Closed

24 tasks

rkratky merged commit 6fd9f92 into master Aug 14, 2019

rkratky deleted the sv/language branch August 14, 2019 16:02

che-bot removed the status/code-review label Aug 14, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documantation how to add support for a new language #746

Add documantation how to add support for a new language #746

svor commented Jul 2, 2019

tsmaeder left a comment

tsmaeder commented Jul 10, 2019

slemeur Jul 23, 2019

slemeur Jul 23, 2019

svor commented Jul 26, 2019

slemeur commented Jul 26, 2019

svor commented Jul 26, 2019

slemeur left a comment

sunix Aug 1, 2019

tsmaeder Aug 14, 2019

sunix Aug 1, 2019

rkratky left a comment

svor commented Aug 2, 2019

sunix commented Aug 6, 2019

rkratky commented Aug 6, 2019

sunix commented Aug 6, 2019

rkratky commented Aug 7, 2019

sunix commented Aug 8, 2019 •

edited

Loading

sunix commented Aug 14, 2019 •

edited

Loading

slemeur commented Aug 14, 2019

Add documantation how to add support for a new language #746

Add documantation how to add support for a new language #746

Conversation

svor commented Jul 2, 2019

What does this PR do?

What issues does this PR fix or reference?

tsmaeder left a comment

Choose a reason for hiding this comment

tsmaeder commented Jul 10, 2019

slemeur Jul 23, 2019

Choose a reason for hiding this comment

slemeur Jul 23, 2019

Choose a reason for hiding this comment

svor commented Jul 26, 2019

slemeur commented Jul 26, 2019

svor commented Jul 26, 2019

slemeur left a comment

Choose a reason for hiding this comment

sunix Aug 1, 2019

Choose a reason for hiding this comment

tsmaeder Aug 14, 2019

Choose a reason for hiding this comment

sunix Aug 1, 2019

Choose a reason for hiding this comment

rkratky left a comment

Choose a reason for hiding this comment

svor commented Aug 2, 2019

sunix commented Aug 6, 2019

rkratky commented Aug 6, 2019

sunix commented Aug 6, 2019

rkratky commented Aug 7, 2019

sunix commented Aug 8, 2019 • edited Loading

sunix commented Aug 14, 2019 • edited Loading

slemeur commented Aug 14, 2019

sunix commented Aug 8, 2019 •

edited

Loading

sunix commented Aug 14, 2019 •

edited

Loading