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

Write documentation on how to 'Creating Eclipse Theia Plug-ins with Eclipse Che' #12425

Closed
26 tasks
evidolob opened this issue Jan 15, 2019 · 6 comments
Closed
26 tasks
Labels
area/doc Issues related to documentation

Comments

@evidolob
Copy link
Contributor

evidolob commented Jan 15, 2019

Description

We need this documentation for Che 7 Beta
Should this be on che-docs repository?

Here is a proposition for the outline:
Creating Eclipse Theia Plug-ins with Eclipse Che

  • Developing your first plug-in
  • What is a Plug-in
    • Plug-in concept in details
    • Plug-in metadatas
    • Plug-in Lifecycle
  • Embedded vs Remote Plug-in
    • Introduction of Embedded Plug-in (diagram)
    • Introduction of Remote Plug-in (diagram)
    • Comparison matrix
  • Creating New Plug-ins
    • Explain how to scaffold a new plugin
    • List of plugin samples
    • Plugin generation
    • Links to “How-to” guides (how to add a new language, how to add a new debugger, how to package a VSCode plug-in for Eclipse Che)
  • Developing Plug-ins
    • Explain what is the developer experience
    • Explain self hosting
    • Show code completion
  • Testing Plug-ins
  • Publishing Plug-ins
    • Plug-in registry
    • Adding a plug-in into a workspace
    • Sharing your plug-in with a Factory
  • Plug-ins Contribution Points
    • List of all the contributions points
    • Link to API reference for developer
@evidolob
Copy link
Contributor Author

@slemeur Can you provide more information on what we should cover in this documentation?

@slemeur
Copy link
Contributor

slemeur commented Jan 16, 2019

Should this be on che-docs repository?

Here is a proposition for the outline:
Creating Eclipse Theia Plug-ins with Eclipse Che

  • Developing your first plug-in
  • What is a Plug-in
    • Plug-in concept in details
    • Plug-in metadatas
    • Plug-in Lifecycle
  • Embedded vs Remote Plug-in
    • Introduction of Embedded Plug-in (diagram)
    • Introduction of Remote Plug-in (diagram)
    • Comparison matrix
  • Creating New Plug-ins
    • Explain how to scaffold a new plugin
    • List of plugin samples
    • Plugin generation
    • Links to “How-to” guides (how to add a new language, how to add a new debugger, how to package a VSCode plug-in for Eclipse Che)
  • Developing Plug-ins
    • Explain what is the developer experience
    • Explain self hosting
    • Show code completion
  • Testing Plug-ins
  • Publishing Plug-ins
    • Plug-in registry
    • Adding a plug-in into a workspace
    • Sharing your plug-in with a Factory
  • Plug-ins Contribution Points
    • List of all the contributions points
    • Link to API reference for developer

cc @rkratky

@dneary
Copy link
Contributor

dneary commented Jan 18, 2019

We should also have an API guide - including some idea of API calls from VS Code covered vs uncovered.

@sunix
Copy link
Contributor

sunix commented Mar 13, 2019

@slemeur @l0rd could we close this issue ? handled by the che-doc team ?

@benoitf
Copy link
Contributor

benoitf commented Jul 4, 2019

done ?

@sunix
Copy link
Contributor

sunix commented Jul 4, 2019

Let's close it @slemeur @rkratky @evidolob you can reopen new issue if some part is missing

@sunix sunix closed this as completed Jul 4, 2019
@benoitf benoitf added area/doc Issues related to documentation and removed kind/docs labels Jul 9, 2019
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
Projects
None yet
Development

No branches or pull requests