Skip to content

Commit d663406

Browse files
author
Prabha Kylasamiyer Sundara Rajan
committed
MTA-5637 Developer Lightspeed: Running an analysis and applying fixes
1 parent 0de6fce commit d663406

File tree

8 files changed

+101
-0
lines changed

8 files changed

+101
-0
lines changed

‎assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
:_newdoc-version: 2.18.3
2+
:_template-generated: 2025-04-08
3+
4+
ifdef::context[:parent-context-of-run-dev-lightspeed-analysis: {context}]
5+
6+
:_mod-docs-content-type: ASSEMBLY
7+
8+
ifndef::context[]
9+
[id="run-dev-lightspeed-analysis"]
10+
endif::[]
11+
ifdef::context[]
12+
[id="run-dev-lightspeed-analysis_{context}"]
13+
endif::[]
14+
= Generating and resolving issues by using {mta-dl-plugin}
15+
16+
:context: run-dev-lightspeed-analysis
17+
18+
After you complete the configurations, the next step is running an analysis to identify the issues and generate suggestions to address the issues. You can run an analysis by using {mta-dl-plugin} by using the solution server or in the agent mode.
19+
20+
When you run an analysis in either mode, {mta-dl-plugin} automatically performs the following tasks:
21+
22+
* Displays issues in all the files in your project in the `Issues` pane.
23+
* Generates new files in `Resolutions` pane that have the updates to the code that resolves the issues detected in the current analysis. You can review the changes, apply, or revert the fixes.
24+
* Click `Source Control` to access all the newly generated files with the latest file listed at the top.
25+
26+
If you apply all the resolutions, {mta-dl-plugin} applies the changes and triggers another analysis to check if there are more issues.
27+
28+
include::topics/developer-lightspeed/proc_running-rag-analysis.adoc[leveloffset=+1]
29+
30+
include::[leveloffset=+1]
31+
32+
33+
ifdef::parent-context-of-run-dev-lightspeed-analysis[:context: {parent-context-of-run-dev-lightspeed-analysis}]
34+
ifndef::parent-context-of-run-dev-lightspeed-analysis[:!context:]
35+

‎assemblies/developer-lightspeed-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../topics/

‎docs/developer-lightspeed-guide/assemblies

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../assemblies/

‎docs/developer-lightspeed-guide/master-docinfo.xml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<title>Developer Lightspeed Guide</title>
2+
<productname>{DocInfoProductName}</productname>
3+
<productnumber>{DocInfoProductNumber}</productnumber>
4+
<subtitle>Using the {ProductName} Developer Lightspeed to modernize your applications</subtitle>
5+
<abstract>
6+
<para>you can use {ProductFullName} Developer Lightspeed for application modernization in your organization by running Artificial Intelligence-driven static code analysis for Java applications.</para>
7+
</abstract>
8+
<authorgroup>
9+
<orgname>Red Hat Customer Content Services</orgname>
10+
</authorgroup>
11+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />

‎docs/developer-lightspeed-guide/master.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:mta:
2+
include::topics/templates/document-attributes.adoc[]
3+
:_mod-docs-content-type: ASSEMBLY
4+
[id="mta-developer-lightspeed"]
5+
= MTA Developer Lightspeed Guide
6+
7+
:toc:
8+
:toclevels: 4
9+
:numbered:
10+
:imagesdir: topics/images
11+
:context: mta-developer-lightspeed
12+
:mta-developer-lightspeed:
13+
14+
//Inclusive language statement
15+
include::topics/making-open-source-more-inclusive.adoc[]
16+
17+
18+
include::assemblies/developer-lightspeed-guide/assembly_run-dev-lightspeed-analysis.adoc[leveloffset=+1]
19+
20+
:!mta-developer-lightspeed:

‎docs/developer-lightspeed-guide/topics

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../topics/

‎docs/topics/developer-lightspeed/proc_running-rag-analysis.adoc

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
:_newdoc-version: 2.15.0
2+
:_template-generated: 2024-2-21
3+
:_mod-docs-content-type: PROCEDURE
4+
5+
[id="running-rag-analysis_{context}"]
6+
= Running an analysis by using solution server
7+
8+
[role="_abstract"]
9+
Solution server uses Retrieval Augmented Generation (RAG) to generate a resolution contextually. Solution server derives the context from rules and past changes to similar issues in the codebase of your organization and generates a hint or a prompt for your large language model (LLM). The LLM defines the issues and generates resolutions given the contextual prompt.
10+
11+
An analysis completed by the solution server shows the success metrics for incidents. Success metrics
12+
13+
.Prerequisites
14+
15+
* You installed the {ProductShortName} distribution version 8.0.0 in your system.
16+
* You installed Jave 17+ and Maven 3.9.9+ in your system.
17+
* You installed the {ProductFullName} extension version 8.0.0 in VS Code.
18+
* You installed the latest version of Language Support for Java(TM) by Red Hat extension in Visual Studio (VS) Code.
19+
* You opened a Java project in your VS Code workspace.
20+
* You enabled the solution server in the {mta-dl-plugin} extension settings and restarted VS Code.
21+
* You configured an analysis profile.
22+
23+
.Procedure
24+
25+
. Review and resolve the issues from the `Analysis results` space of the `Konveyor view analysis` page by the following tabs:
26+
27+
* *All*: lists all incidents identified in your project.
28+
* *Files*: lists all the files in your project for which the analysis identified issues that must be resolved.
29+
* *Issues*: lists all issues across different files in your project.
30+
31+
You can also apply resolutions for all files at once from the `Resolutions` pane.

‎docs/topics/templates/document-attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ ifdef::mta[]
2828
:WebConsoleBookName: {WebNameTitle} Guide
2929
:ProductVersion: 7.3.1
3030
:PluginName: MTA plugin
31+
:mta-dl-plugin: MTA with Developer Lightspeed
3132
// :MavenProductVersion: 7.0.0.GA-redhat-00001
3233
:ProductDistributionVersion: 7.3.1.GA-redhat
3334
:ProductDistribution: mta-7.3.1.GA-cli-offline.zip

0 commit comments

Comments
 (0)