-
Notifications
You must be signed in to change notification settings - Fork 8
MTA-6288 Centralized configuration in Visual Studio Code plugin #313
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
Open
Pkylas007
wants to merge
5
commits into
main
Choose a base branch
from
mta-6288-centralized-config-vscode-ide-plugin
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
50445d8
MTA-6288 Centralized configuration in Visual Studio Code plugin
1f7bf75
Modifed an image and the introduction
8436d8e
Made updates based on peer review feedback
8b005a8
Changed the source code language in IDE extension
eb10090
Fixed a typo
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
47 changes: 47 additions & 0 deletions
47
docs/topics/vscode/proc_vscode-analyzing-application-using-profiles.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
| [id="analyzing-application-profiles_{context}"] | ||
| = Running an application analysis by using a profile | ||
|
|
||
| [role="_abstract"] | ||
| To run a static code analysis of an application, you can use a profile that is created and managed by your architect in the {ProductShortName} Hub. The centralized configuration management standardizes the analysis configuration and custom rules across projects to produce a consistent result. This allows the architect to create and manage the necessary profiles, thereby simplifying the lifecycle of analysis configurations and rules. Migrators can run analyses either by using local profile configuration or by using profiles from the Hub. | ||
|
|
||
| When you connect to the Hub from your Visual Studio Code instance, {ProductShortName} downloads the analysis profiles and custom rules present in the Hub to the `.konveyor/profiles` location in your hard disk. You can use the analysis profile that contains custom rules to perform analyses in your Visual Studio Code IDE environment. If you connect to the Hub, the profile configuration options in your IDE instance are disabled. | ||
|
|
||
|
|
||
| :FeatureName: Analysis Profile | ||
| [IMPORTANT] | ||
| ==== | ||
| [subs="attributes+"] | ||
| {FeatureName} is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. | ||
|
|
||
| For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview/[Technology Preview Features Support Scope]. | ||
| ==== | ||
| :!FeatureName: | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * You opened a project written in one of the supported languages in your VS Code workspace. | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * An architect has configured an analysis profile in the Hub. | ||
|
|
||
| .Procedure | ||
|
|
||
| . Click the {mta-dl-plugin} extension and click *Open Analysis Panel*. | ||
|
|
||
| . Click *Configure Hub Settings* in settings (image:settings-icon.png[]). | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| . Configure the following settings on the *Hub Configuration* page: | ||
| .. Enable *Hub*. | ||
| .. Enter the {ProductShortName} user interface URL in the *Hub URL* field. | ||
| .. Enable *Skip SSL certificate verification* if you want to connect to your Hub without verifying the local SSL certificate in the host. | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| .. Toggle *Enable authentication* on to log in to your Hub. | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| .. Enter the username and password credentials of the {ProductShortName} user interface. | ||
| .. Enable *Solution Server* to use the solution server to suggest resolutions for the issues in the source code. | ||
| .. Enable *Profile Sync* to sync the profiles with the Hub. {ProductShortName} periodically downloads the latest version of the profiles from the Hub. {ProductShortName} does not update the profiles and rules if you do not sync the profiles with the Hub. | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| . Select a profile from the list on the *{ProductShortName} Analysis View* page. | ||
| . Click *Run Analysis*. | ||
|
|
||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
| * link:https://docs.redhat.com/en/documentation/migration_toolkit_for_applications/8.0/html/developer-lightspeed-guide/index[Configuring and using Developer Lightspeed for {ProductShortName}] | ||
Pkylas007 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.