Skip to content

Commit 2df0e33

Browse files
committed
Update installation guide
Update installation guide
1 parent 20d9c79 commit 2df0e33

6 files changed

+18
-5
lines changed

docs/images/setup-konveyor-2.png

525 KB
Loading

docs/images/walkthrough-1.png

445 KB
Loading

docs/images/walkthrough-2.png

521 KB
Loading

docs/images/walkthrough-3.png

466 KB
Loading

docs/images/walkthrough-4.png

466 KB
Loading

docs/installation.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,23 @@ Only follow these steps if you decided to skip installing from the UI side and y
5151

5252
### Running Kai RPC server
5353

54-
1. Open walkthrough after installing the extension to setup Konveyor
55-
![walkthrough](images/walkthrough.png)
56-
2. User has an option to override binaries and custom rules, however it comes with the default packaged binaries and custom rules.
54+
1. Users will land on the welcome page as shown below.
55+
![walkthrough](images/walkthrough-1.png)
56+
If "Set up Konveyor" is not available in the list, click the More button for additional options.
57+
![walkthrough](images/walkthrough-2.png)
58+
If the welcome page does not appear, open the command palette by pressing Ctrl + Shift + P. This will bring up a list of commands.
59+
![walkthrough](images/walkthrough-3.png)
60+
From the command palette, locate and select the "Set up Konveyor" option. This will guide you through the configuration process.
61+
![walkthrough](images/walkthrough-4.png)
62+
2. Configure Konveyor for your project.
63+
- User has an option to override binaries and custom rules, however it comes with the default packaged binaries and custom rules.
5764
![setup-konveyor](images/setup-konveyor.png)
58-
3. Configure analysis argument is necessary in order to know which rules apply to the project during analysis.
59-
4. Once the configuration is done, click on start server button. Logs are collected at output channel named konveyor-analyzer.
65+
- The Konveyor extension allows you to add custom rules to the analyzer. This is useful when you want to apply your own rules during analysis.
66+
- Configuring analysis arguments is necessary to determine which rules apply to the project during analysis. Set up analysis arguments specific to your project by selecting the appropriate options and pressing "Enter" to save the changes.
67+
- To confirm your arguments, navigate to your project directory and open `/.vscode/settings.json`.
68+
![setup-konveyor](images/setup-konveyor-2.png)
69+
- Next, Setup Generative AI key for your project. (Note: If you choose to use OpenAI, define an environment variable by running the following command `export OPENAI_API_KEY="your_api_key_here"`)
70+
- Modify the /.vscode/settings.json file to include your project-specific arguments about LLM model. [Click here for more details](https://github.com/konveyor/kai/blob/main/docs/scenarios/demo.md#step-1-setup) on this step. `/.vscode/settings.json`.
71+
- As the final step, select "Get Solution Parameters".
72+
3. Once the configuration is done, click on start server button. Logs are collected at output channel named konveyor-analyzer.
6073
![start-server](images/start-server.png)

0 commit comments

Comments
 (0)