[GR-42704] Corrections and improving image rendering.

olyagpl · olyagpl · commit fc54c356ea12 · 2022-12-14T05:42:44.000Z
PullRequest: graal/13379
diff --git a/docs/reference-manual/native-image/guides/build-native-shared-library.md b/docs/reference-manual/native-image/guides/build-native-shared-library.md
@@ -116,7 +116,7 @@ $GRAALVM_HOME/bin/gu install llvm-toolchain
 
     ```shell
     $GRAALVM_HOME/bin/javac LibEnvMap.java
-    $GRAALVM_HOME/bin/native-image -H:Name=LibEnvMap --shared 
+    $GRAALVM_HOME/bin/native-image -H:Name=libenvmap --shared 
     ```
 
     It will produce the following artifacts:
diff --git a/docs/reference-manual/native-image/guides/build-spring-app-into-native-executable.md b/docs/reference-manual/native-image/guides/build-spring-app-into-native-executable.md
@@ -39,7 +39,7 @@ Now follow these steps to create a Spring Boot REST-based application and compil
 
     - Go to [start.spring.io](https://start.spring.io/) and select the following values:
 
-        ![Spring Initializr](../assets/spring_initializr.png)
+        ![Spring Initializr](img/spring_initializr.png)
         
         Make sure you add the **GraalVM Native Support** dependency, and name the artifact and project "jibber".
 
diff --git a/docs/reference-manual/native-image/guides/img/spring_initializr.png b/docs/reference-manual/native-image/guides/img/spring_initializr.png
diff --git a/docs/tools/vscode/graalvm/README.md b/docs/tools/vscode/graalvm/README.md
@@ -14,25 +14,25 @@ permalink: /tools/vscode/graalvm-extension/
 * [Native Image Support](#native-image-support)
 * [Extension Settings](#extension-settings)
 
-[GraalVM Tools for Java](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.graalvm) extension provides capabilities to manage GraalVM installations and its components in VS Code and locally. 
+[GraalVM Tools for Java](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.graalvm) extension provides capabilities to manage GraalVM installations and its components in VS Code and/or locally. 
 The extension ships a GraalVM installation and configuration wizard. 
 You can conveniently set up the default Java runtime to GraalVM JDK which comes with both just-in-time ([Graal](../../../reference-manual/java/compiler.md)) and ahead-of-time ([Native Image](../../../reference-manual/native-image/README.md)) compilers, making VS Code a comfortable and convenient integrated environment.
 
 The GraalVM Tools for Java in combination with the [GraalVM Tools for Micronaut](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.micronaut) brings native support for the Micronaut framework in VS Code and opens many more possibilities for Java developers.
 
-> Note: The extension is a Technology Preview, and the development team is actively working on further improvements to provide better usability for developers.
+> Note: The extension is a Technology Preview. The development team is actively working on further improvements to provide better usability for developers.
 
 ## Extension Installation
 
 To install the GraalVM Tools for Java extension in VS Code, do the following:
 
 1. Navigate to Extensions in the Activity Bar.
 2. Search for "GraalVM" in the search field.
-3. Once found, click **Install**. That action will install the GraalVM Tools for Java extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.graalvm).
+3. Once found, click **Install**. That action installs the GraalVM Tools for Java extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=oracle-labs-graalvm.graalvm).
 4. Reload when required.
 
 The extension depends on the [Apache NetBeans Language Server](https://marketplace.visualstudio.com/items?itemName=ASF.apache-netbeans-java). (VS Code installs it for you.)
-When the extension (and its dependent) is installed, VS Code will display the **Gr** icon in the Activity Bar on the left.
+When the extension (and its dependent) is installed, VS Code displays the **Gr** icon in the Activity Bar on the left.
 
 ## GraalVM Installation Wizard
 
@@ -42,8 +42,8 @@ To start, click the **Gr** icon in the Activity Bar. You can either add an exist
 A dialogue window suggests these options:
   * **Download & Install GraalVM**
   * **Add Existing GraalVM**
-
-    ![GraalVM Install Dialog](images/graalvm_install_actions.png)
+  
+    <img src="images/graalvm_install_actions.png" alt="GraalVM Install Dialog" style="width: 50%;">
 
 The **Download & Install GraalVM** action is recommended as it eliminates the fuss around setting up environment variables for you.
 
@@ -67,16 +67,16 @@ Follow these steps to download and install GraalVM Community Edition:
 3. Pick one of the available Java versions.
 4. Select the destination folder.
 
-The installation will start immediately.
-The wizard will download the package from [Github](https://github.com/graalvm/graalvm-ce-builds/releases) in the background and display progress.
+The installation starts immediately.
+The wizard downloads the package from [Github](https://github.com/graalvm/graalvm-ce-builds/releases) in the background and display progress.
 
-Once the installation completes, the **Install Optional GraalVM Components** window will pop up prompting you to install additional language runtimes and utilities (Native Image, JavaScript, Node.js, LLVM, Python, Ruby, etc.) to the core package:
+Once the installation completes, the **Install Optional GraalVM Components** window pops up prompting you to install additional language runtimes and utilities (Native Image, JavaScript, Node.js, LLVM, Python, Ruby, etc.) to the core package:
 
-![Install Optional GraalVM Components](images/install_optional_components_popup.png)
+<img src="images/install_optional_components_popup.png" alt="Install Optional GraalVM Components" style="width: 50%;">
 
 Once you confirm, you are taken to the selection list:
 
-![Select Components to Install](images/install_components_action.png)
+<img src="images/install_components_action.png" alt="Select Components to Install" style="width: 50%;">
 
 ### Download and Install GraalVM Enterprise
 
@@ -88,11 +88,11 @@ Follow these steps to download and install GraalVM Enterprise:
 2. Pick the GraalVM version: one of the latest major stable releases.
 3. Pick one of the available Java versions.
 4. Select the destination folder.
-5. Provide a valid email address where the license will be sent or enter the existing download token.  
+5. Provide a valid email address where the license should be sent or enter the existing download token.  
    Supposedly, this is your first installation and you have not accepted the license yet.
    Press `Enter`. Once the email address is entered, you see this popup in the bottom right corner:
 
-    ![Continue Download popup](images/continue_download_gds.png)
+    <img src="images/continue_download_gds.png" alt="Continue Download popup" style="width: 50%;">
 
     You are sent an email to verify your email address and accept the license.
 
@@ -102,21 +102,19 @@ Follow these steps to download and install GraalVM Enterprise:
 
 8. Return to VS Code and press **Continue Download** to continue. Your download token is then generated and saved by default in the `.gu/config` file in user's home directory (you can update the storage location later, see below).
 
-    ![Download Token generated](images/download_token_generated.png)
-
-    The download and installation of GraalVM Enterprise will start. You will see the installation notification: 
 
-    ![GraalVM Enterprise installation in progress](images/ee_installation_started.png)
+    <img src="images/download_token_generated.png" alt="Download Token generated" style="width: 50%;">
 
-    The installation wizard will download a package from Oracle's storage point.
+    The download and installation of GraalVM Enterprise starts.
+    The installation wizard downloads a package from Oracle's storage point.
 
     If you clicked **Continue Download** without accepting the license, you would see the following warning:
 
-    ![Continue Download without license acceptance](images/continue_download_not_accepted.png)
+    <img src="images/continue_download_not_accepted.png" alt="Continue Download without license acceptance" style="width: 50%;">
 
     > Note: If your machine is behind a proxy, you must set your environment variables (`http_proxy`, `https_proxy`) appropriately. You can use the quick command  **Setup Proxy**.
 
-Once the installation completes, the **Install Optional GraalVM Components** window will pop up prompting you to install additional language runtimes and utilities (Native Image, JavaScript, Node.js, LLVM, Python, Ruby, etc.) to the core package. Once you confirm, you are taken to the selection list. 
+Once the installation completes, the **Install Optional GraalVM Components** window pops up prompting you to install additional language runtimes and utilities (Native Image, JavaScript, Node.js, LLVM, Python, Ruby, etc.) to the core package. Once you confirm, you are taken to the selection list. 
 Since you already have a download token and accepted the license, components will be installed without any additional interaction.
 
 #### Show Current Download Configuration
@@ -126,11 +124,11 @@ Once copied you can re-use the download token, for example, (1) to install Graal
 
 1. Go to **View**, then **Command Palette** and search for **GraalVM: Show GU Configuration**:
 
-    ![Show Download Configuration action](images/show_gu_config.png)
+    <img src="images/show_gu_config.png" alt="Show Download Configuration action" style="width: 50%;">
 
-2. Click **GraalVM: Show GU Configuration**. You will see the popup window with a similar content:
+2. Click **GraalVM: Show GU Configuration**. You see the popup window with a similar content:
 
-    ![Download Configuration window](images/gu_config_window.png)
+    <img src="images/gu_config_window.png" alt="Download Configuration window" style="width: 50%;">
 
 3. Copy the download token.
 
@@ -142,7 +140,7 @@ If you would like to define a custom file containing a download token, you can d
 2. Open the GraalVM for Java extension settings and find the **GU** field.
 3. Provide a custom file containing the download token:
 
-   ![Download Configuration window](images/define_custom_path.png)
+    <img src="images/define_custom_path.png" alt="Download Configuration window" style="width: 50%;">
 
 ## Set Default Java Runtime
 
@@ -152,10 +150,10 @@ When the installation is complete, the **Set Default Java** action is invoked.
 
 2. Select both **Set as JAVA for Terminal** options (`JAVA_HOME` and `PATH`) in the **Configure active GraalVM** window:
 
-    ![Set as JAVA for Terminal](images/set_as_java_for_terminal.png)
+    <img src="images/set_as_java_for_terminal.png" alt="Set as JAVA for Terminal" style="width: 50%;">
 
 Alternatively, you can invoke the same action from **View**, then **Command Palette** (use the `Ctrl+Shift+P` hot keys combination for Linux, and `Command+Shift+P` for macOS to open the commands palette), and search for "GraalVM".
-You will see **GraalVM: Set Active GraalVM Installation** among other actions.
+You see **GraalVM: Set Active GraalVM Installation** among other actions.
 
 ## Java Development and Debugging
 
@@ -171,10 +169,10 @@ If VS Code detects the Extension Pack for Java from Microsoft installed, it deac
 The GraalVM Tools for Java extension provides integration with [VisualVM](https://visualvm.github.io), the all-in-one Java (and polyglot) monitoring and troubleshooting tool.
 VisualVM brings powerful yet easy-to-use visual Java tooling to VS Code.
 
-When you run a Java application, the process ID will be detected automatically and displayed in the **VISUALVM** pane. 
+When you run a Java application, the process ID is detected automatically and displayed in the **VISUALVM** pane. 
 Open VisualVM by just clicking the play button:
 
-![VisualVM and VS Code Integration](images/open_visualvm.png)
+<img src="images/open_visualvm.png" alt="VisualVM and VS Code Integration" style="width: 50%;">
 
 For more information, see the [dedicated guide](visualvm-integration.md) how to start using VisualVM from within VS Code.
 
@@ -188,13 +186,13 @@ Thanks to [GraalVM Tools for Java](https://marketplace.visualstudio.com/items?it
 
 GraalVM Tools for Java extension provides the **NATIVE IMAGE** with **Agent** pane to automate the process of tracking and registering dynamic feature calls, making it easier to configure and build a native executable in VS Code. The [tracing agent](../../../reference-manual/native-image/AutomaticMetadataCollection.md) tracks dynamic feature calls whilst your application is running on a JVM, and records those calls into JSON configuration files.
 
-![Native Image Agent pane](images/ni_agent_pane.png)
+<img src="images/ni_agent_pane.png" alt="Native Image Agent pane" style="width: 50%;">
 
-> Note: The **NATIVE IMAGE** pane will show up when you open your Java project in VS Code. 
+> Note: The **NATIVE IMAGE** pane shows up when you open your Java project in VS Code. 
 
 > Note: The support for the Native Image agent is experimental.
 
-In the next section you will learn how to build a native executable of a Java application and apply the Tracing agent in VS code.
+In the next section you learn how to build a native executable of a Java application and apply the Tracing agent in VS code.
 
 ### Building
 
@@ -203,9 +201,9 @@ To build a native executable of your Java application in VS Code, do the followi
 1. Create the _launch.json_ file. If not already created, create a new file from the **Run and Debug** activity panel using the _create a launch.json file_ link. Select the **Java 8+ environment** when asked. Save the _launch.json_ file after editing it.
 2. Enable the Tracing agent. Click **Gr** in the left sidebar and expand the **NATIVE IMAGE** pane. Expand **Agent** and click the edit button to configure its state.
 
-    Select **enabled** so the Native Image agent will start with the Java process:
+    Select **enabled** so the Native Image agent starts with the Java process:
 
-    ![Enable Native Image Agent state](images/enable_ni_agent.png)
+    <img src="images/enable_ni_agent.png" alt="Enable Native Image Agent state" style="width: 50%;">
 
     > Note: The state is not remembered: if you close the VS Code window, it will change back to **disabled**.
 
@@ -236,19 +234,17 @@ If you use the Micronaut framework to create your Java project, you can build a
 ### Building Native Images on Windows
 
 To use Native Image on Windows, you need Visual Studio Build Tools with Windows SDK installed. 
-The `native-image` builder will only work when it is executed from the **x64 Native Tools Command Prompt**. Check [this link](https://medium.com/graalvm/using-graalvm-and-native-image-on-windows-10-9954dc071311) for more details.
+The `native-image` builder only works when it is executed from the **x64 Native Tools Command Prompt**. Check [this link](https://medium.com/graalvm/using-graalvm-and-native-image-on-windows-10-9954dc071311) for more details.
 
 For Windows users, the extension provides a pre-configured x64 command prompt using Microsoft Developer Tools. Assuming you already have Visual Studio Build Tools with Windows SDK, GraalVM with Native Image installed, and opened your Java project in VS Code.
 
 1. In the **NATIVE IMAGE** pane, click on right arrow, **>**:
 
-    ![NATIVE IMAGE page on Windows](images/ni_pane_windows.png)
-    
-    It will open a dialog window asking you to select an existing Windows SDK build tools configuration script (`vcvars64.bat`) from the default installation location, or to select a custom configuration script. VS Code will detect the script and pre-populate the path:
+    <img src="images/ni_pane_windows.png" alt="NATIVE IMAGE page on Windows" style="width: 50%;">
 
-    ![Provide Path to Microsoft Build Tools Script](images/path_build_tools_script.png)
+    It opens a dialog window asking you to select an existing Windows SDK build tools configuration script (`vcvars64.bat`) from the default installation location, or to select a custom configuration script. VS Code detects the script and pre-populate the path. 
 
-2. Click enter. A new Terminal window will open running inside the x64 native tools command prompt.
+2. Click enter. A new Terminal window opens running inside the x64 native tools command prompt.
 
     Note that the path to Windows SDK build tools is saved globally, so next time you open a New Terminal 
     from the **NATIVE IMAGE** pane, it will run inside the x64 native tools command prompt.
@@ -266,7 +262,7 @@ Learn more about GraalVM Native Image [here](../../../reference-manual/native-im
 The GraalVM Tools for Java provide Java-like debugging of a native executable in a running state directly from within VS Code.
 You can set breakpoints, inspect the state of your application, even attach the debugger to a native image process in VS Code and step over the Java application source code.
 
-![Native Image Debugging in VS Code](images/debugging_ni_vscode.png)
+<img src="images/debugging_ni_vscode.png" alt="Native Image Debugging in VS Code">
 
 > Note: To debug a native executable from within VS Code, you must install GraalVM Enterprise.
 
