Merge pull request #990 from anusreelakshmi934/documentation

Documentation for developers to understand continuous build integration
OpenLiberty · Sep 27, 2024 · 1164551 · 1164551
2 parents 8e3f772 + 962d590
commit 1164551
Show file tree

Hide file tree

Showing 19 changed files with 337 additions and 0 deletions.
diff --git a/DEVELOPING.md b/DEVELOPING.md
@@ -61,6 +61,10 @@ To debug the LemMinX Language Server in IntelliJ, complete the following steps.
 
 For more information, see the [LSP console user guide](https://github.com/redhat-developer/lsp4ij/blob/main/docs/UserGuide.md#lsp-console)
 
+### Continuous Integration of LSP4IJ
+
+For details on the Continuous Integration (CI) setup for LSP4IJ integration, refer to the [LSP4IJ Continuous Integration documentation.](docs/LSP4IJ-Continuous-Integration.md) 
+
 ## Localization
 
 ### LibertyBundles.properties

diff --git a/README.md b/README.md
@@ -12,6 +12,10 @@
 
 Liberty Tools for IntelliJ IDEA is an IntelliJ IDEA plugin for developing cloud-native Java applications with [Open Liberty](https://openliberty.io/) and [WebSphere Liberty](https://www.ibm.com/products/websphere-liberty). Iterate fast with Liberty dev mode, code with assistance for MicroProfile and Jakarta EE APIs, and easily edit Liberty configuration files.
 
+Liberty Tools for IntelliJ includes LSP4IJ, an external plugin dependency that is automatically installed with Liberty Tools. LSP4IJ is a free and open-source Language Server Protocol (LSP) client developed by Red Hat, enabling seamless language server integration.
+
+If you wish to change the version of LSP4IJ installed along with Liberty Tools, you can refer to the documentation [here](docs/user-guide.md#manually-install-specific-release-of-the-lsp4ij-plugin-from-the-marketplace).
+
 ![Liberty Tools Extension](docs/images/liberty-tool-window-view.png)
 
 ---

diff --git a/docs/LSP4IJ-Continuous-Integration.md b/docs/LSP4IJ-Continuous-Integration.md
diff --git a/docs/images/Artifact-names.png b/docs/images/Artifact-names.png
diff --git a/docs/images/Build-artifacts.png b/docs/images/Build-artifacts.png
diff --git a/docs/images/Build-failed.png b/docs/images/Build-failed.png
diff --git a/docs/images/LSP4IJ-Install Plugin from disk.png b/docs/images/LSP4IJ-Install Plugin from disk.png
diff --git a/docs/images/Normal-builds.png b/docs/images/Normal-builds.png
diff --git a/docs/images/Pr-details.png b/docs/images/Pr-details.png
diff --git a/docs/images/Test-reports.png b/docs/images/Test-reports.png
diff --git a/docs/images/Warnings-PR.png b/docs/images/Warnings-PR.png
diff --git a/docs/images/Workflow-dispatch.png b/docs/images/Workflow-dispatch.png
diff --git a/docs/images/build-results-slack-view.png b/docs/images/build-results-slack-view.png
diff --git a/docs/images/example-manually-trigger.png b/docs/images/example-manually-trigger.png
diff --git a/docs/images/manually-trigger.png b/docs/images/manually-trigger.png
diff --git a/docs/images/result-cron-job.png b/docs/images/result-cron-job.png
diff --git a/docs/images/specify-LTI-tags-branches.png b/docs/images/specify-LTI-tags-branches.png
diff --git a/docs/images/version.png b/docs/images/version.png
diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -7,6 +7,7 @@ For information regarding known issues and limitations, refer to our [Common Iss
     - [Software requirements](#software-requirements)
     - [Application requirements](#application-requirements)
     - [Settings](#settings)
+- [Manually install specific release of the LSP4IJ plugin from the Marketplace](#manually-install-specific-release-of-the-lsp4ij-plugin-from-the-marketplace)
 - [Open the Liberty tool window](#open-the-liberty-tool-window)
 - [Run your application on Liberty using dev mode](#run-your-application-on-liberty-using-dev-mode)
     - [Use the Liberty tool window](#use-the-liberty-tool-window)
@@ -50,6 +51,25 @@ Liberty Tools for IntelliJ IDEA honors the following settings:
 #### Environment Variables:
 - The **JAVA_HOME** system environment variable in the current terminal is used when you run Liberty dev mode in any project.
 
+## Manually install specific release of the LSP4IJ plugin from the Marketplace
+
+When installing the Liberty Tools for IntelliJ plugin, the latest version of LSP4IJ from the JetBrains marketplace will be installed by default.
+
+If you prefer to use an older version of LSP4IJ (e.g., the specific version that was tested with the Liberty Tools release you are using), you can manually downgrade it by installing the desired version as a dependency from the [JetBrains marketplace](https://plugins.jetbrains.com/plugin/23257-lsp4ij/versions).
+
+
+Steps to install an older version of LSP4IJ:
+1. Go to the Plugins tab in the IDE Settings and uninstall the latest version.
+
+2. Download the desired version from the provided link above; it will be saved as a zip file.
+
+3. Reopen the IDE settings and navigate to the Plugins section.
+
+4. Click the gear icon, then select "Install Plugin from Disk," and choose the downloaded zip file.
+   <img alt="Install Plugin from disk" height="300" src="images/LSP4IJ-Install Plugin from disk.png" width="350"/>
+
+5. Confirm by clicking OK, then apply the changes. If prompted, restart your IDE.
+
 ## Open the Liberty tool window
 Select **View > Tool Windows > Liberty**.