feat(recommendations-plugin): Add the documentation for the feature o…

…f recommendations plug-in Change-Id: I2e6a708849d821ed1dd5ab2f9c9db9472b207c61 Signed-off-by: Florent Benoit <[email protected]>
eclipse-che · Mar 2, 2021 · b17da1d · b17da1d
1 parent cee8999
commit b17da1d
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/...end-user-guide/partials/assembly_adding-a-vs-code-extension-to-a-workspace.adoc b/...end-user-guide/partials/assembly_adding-a-vs-code-extension-to-a-workspace.adoc
@@ -19,4 +19,6 @@ include::partial$proc_adding-the-vs-code-extension-using-the-che-plugins-panel.a
 
 include::partial$proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc[leveloffset=+1]
 
+include::partial$proc_adding-the-vs-code-extension-using-recommendations.adoc[leveloffset=+1]
+
 :context: {parent-context-of-adding-che-plug-in-registry-vs-code-extension-to-a-workspace}
diff --git a/...ser-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc b/...ser-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc
@@ -0,0 +1,22 @@
+// Module included in the following assemblies:
+//
+// adding-{prod-id-short}-plug-in-registry-vs-code-extension-to-a-workspace
+
+[id="adding-the-vs-code-extension-using-recommendations-{prod-id-short}_{context}"]
+= Adding a VS Code extension using recommendations
+
+.Prerequisites
+
+* A running instance of {prod-short}. To install an instance of {prod-short}, see {link-installing-an-instance}.
+* Featured VS Code extensions are available in the {prod-short} plug-in registry.
+
+.Procedure
+
+Open a workspace without any existing devfile using the *{prod-short} dashboard*:
+
+Recommendations plug-in will scan files, discover languages and install VS Code extensions matching these languages.
+Disable this feature by setting `extensions.ignoreRecommendations` to true in the devfile attributes.
+
+Recommendations plug-in can suggest VS Code extensions to install when opening files. It suggests extensions allowing to work with the given files.
+Enable this feature by setting `extensions.openFileRecommendations` to true in the devfile attributes.
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,4 +19,6 @@ include::partial$proc_adding-the-vs-code-extension-using-the-che-plugins-panel.a

		include::partial$proc_adding-the-vs-code-extension-using-the-workspace-configuration.adoc[leveloffset=+1]

		include::partial$proc_adding-the-vs-code-extension-using-recommendations.adoc[leveloffset=+1]

		:context: {parent-context-of-adding-che-plug-in-registry-vs-code-extension-to-a-workspace}