From b17da1dbed8522b2b9a4ca15967d9fee85b0726d Mon Sep 17 00:00:00 2001 From: Florent Benoit Date: Tue, 2 Mar 2021 10:28:48 +0100 Subject: [PATCH 1/3] feat(recommendations-plugin): Add the documentation for the feature of recommendations plug-in Change-Id: I2e6a708849d821ed1dd5ab2f9c9db9472b207c61 Signed-off-by: Florent Benoit --- ...ng-a-vs-code-extension-to-a-workspace.adoc | 2 ++ ...-code-extension-using-recommendations.adoc | 22 +++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc diff --git a/modules/end-user-guide/partials/assembly_adding-a-vs-code-extension-to-a-workspace.adoc b/modules/end-user-guide/partials/assembly_adding-a-vs-code-extension-to-a-workspace.adoc index a5f1810b74..db92935c09 100644 --- a/modules/end-user-guide/partials/assembly_adding-a-vs-code-extension-to-a-workspace.adoc +++ b/modules/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/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc new file mode 100644 index 0000000000..b3ab7a857a --- /dev/null +++ b/modules/end-user-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. + From d05bb5764c5fd62694174a88816246849761a5d8 Mon Sep 17 00:00:00 2001 From: Florent BENOIT Date: Tue, 2 Mar 2021 15:31:35 +0100 Subject: [PATCH 2/3] Update modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc Co-authored-by: Eric Williams --- ...roc_adding-the-vs-code-extension-using-recommendations.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc index b3ab7a857a..e51b5ee9a6 100644 --- a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc +++ b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc @@ -14,9 +14,8 @@ 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. +The 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. - From 1a043cd5d3c0c230694ab6f671443ad0785a9c6e Mon Sep 17 00:00:00 2001 From: Florent BENOIT Date: Tue, 2 Mar 2021 15:31:41 +0100 Subject: [PATCH 3/3] Update modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc Co-authored-by: Eric Williams --- ...proc_adding-the-vs-code-extension-using-recommendations.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc index e51b5ee9a6..e877b58aa3 100644 --- a/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc +++ b/modules/end-user-guide/partials/proc_adding-the-vs-code-extension-using-recommendations.adoc @@ -17,5 +17,5 @@ Open a workspace without any existing devfile using the *{prod-short} dashboard* The 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. +The recommendations plug-in can suggest VS Code extensions to install when opening files. It suggests extensions based on the workspace content, allowing the user to work with the given files. Enable this feature by setting `extensions.openFileRecommendations` to true in the devfile attributes.