Skip to content

Commit

Permalink
Clarify process for adding a VS Code extension to Che (eclipse-che#1074)
Browse files Browse the repository at this point in the history
Improve the docs a bit so that it's clear that a meta.yaml file
can be hosted on GitHub, and not just a self-hosted registry link.

See eclipse-che/che#15982

Signed-off-by: Eric Williams <[email protected]>
  • Loading branch information
ericwill authored and MichalMaler committed Feb 20, 2020
1 parent b394330 commit ee52bb8
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,15 @@ To add a VS Code extension using the workspace configuration:
<1> Link to the `meta.yaml` file in your registry, for example, `https://my-plug-in-registry/v3/plugins/__<publisher>__/__<plug-inName>__/__<plug-inVersion>__/meta.yaml`
+
{prod-short} automatically adds the other fields to the new component.
+
Alternatively, you can link to a `meta.yaml` file hosted on GitHub, via the reference field.
+
[source,yaml,subs="+quotes"]
----
- type: chePlugin
reference: <1>
----
<1> `https://raw.githubusercontent.com/__<username>__/__<registryRepository>__/v3/plugins/__<publisher>__/__<plug-inName>__/__<plug-inVersion>__/meta.yaml`
+

. Restart the workspace for the changes to take effect.

0 comments on commit ee52bb8

Please sign in to comment.