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

feat(recommendations-plugin): Add the documentation for the recommendations plug-in #1876

Merged
merged 5 commits into from
Mar 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// 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*:

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.

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.