diff --git a/doc/getting-started/getting-started.rst b/doc/getting-started/getting-started.rst index 5d44e4ffd..5ce10a0ea 100644 --- a/doc/getting-started/getting-started.rst +++ b/doc/getting-started/getting-started.rst @@ -386,7 +386,7 @@ Generate a Board Configuration File Generate a Scenario Configuration File and Launch Script ********************************************************* -You use the **ACRN configuration editor** to generate scenario configuration files and launch scripts. +You use the **ACRN configurator** to generate scenario configuration files and launch scripts. A **scenario configuration file** is an XML file that holds the parameters of a specific ACRN configuration, such as the number of VMs that can be run, @@ -396,14 +396,14 @@ A **launch script** is a shell script that is used to create a User VM. To generate a scenario configuration file and launch script: -#. On the development computer, install ACRN configuration editor dependencies: +#. On the development computer, install ACRN configurator dependencies: .. code-block:: bash cd ~/acrn-work/acrn-hypervisor/misc/config_tools/config_app sudo pip3 install -r requirements -#. Launch the ACRN configuration editor: +#. Launch the ACRN configurator: .. code-block:: bash @@ -411,7 +411,7 @@ To generate a scenario configuration file and launch script: #. Your web browser should open the website ``__ automatically, or you may need to visit this website manually. - The ACRN configuration editor is supported on Chrome and Firefox. + The ACRN configurator is supported on Chrome and Firefox. #. Click the **Import Board info** button and browse to the board configuration file ``my_board.xml`` previously generated. When it is successfully diff --git a/doc/getting-started/images/gsg_overview_image_sources.pptx b/doc/getting-started/images/gsg_overview_image_sources.pptx index 091d92602..a29b3f862 100644 Binary files a/doc/getting-started/images/gsg_overview_image_sources.pptx and b/doc/getting-started/images/gsg_overview_image_sources.pptx differ diff --git a/doc/getting-started/images/overview_flow.png b/doc/getting-started/images/overview_flow.png index e522f9530..46f034a03 100644 Binary files a/doc/getting-started/images/overview_flow.png and b/doc/getting-started/images/overview_flow.png differ diff --git a/doc/getting-started/overview_dev.rst b/doc/getting-started/overview_dev.rst index 70e13e95e..c84e0033a 100644 --- a/doc/getting-started/overview_dev.rst +++ b/doc/getting-started/overview_dev.rst @@ -210,7 +210,7 @@ and the resources they have access to. These parameters are saved in a A **launch script** is a shell script that is used to create a post-launched VM. -The **configuration editor tool** ``acrn_configurator.py`` is a web-based user interface that +The **ACRN configurator** ``acrn_configurator.py`` is a web-based user interface that runs on your development computer. It enables you to customize, validate, and generate scenario configuration files and launch scripts. The following sections provide an overview and important information to keep in mind when using the @@ -219,7 +219,7 @@ tool. Generate a Scenario Configuration File ====================================== -Before using the configuration editor tool to generate a scenario configuration +Before using the ACRN configurator to generate a scenario configuration file, be sure you have the board configuration file that you generated in :ref:`overview_dev_board_config`. The tool needs the board configuration file to validate that your custom scenario is supported by the target hardware. @@ -235,7 +235,7 @@ configuration file. Generate Launch Scripts ======================= -Before using the configuration editor tool to generate a launch script, be sure +Before using the ACRN configurator to generate a launch script, be sure you have your board configuration file and scenario configuration file. The tool needs both files to validate your launch script configuration. @@ -247,7 +247,7 @@ configuration file and scenario configuration file. After validation is successful, the tool generates your custom launch script. .. note:: - The configuration editor may not show all editable + The ACRN configurator may not show all editable parameters for scenario configuration files and launch scripts. You can edit the parameters manually. See :ref:`acrn_config_data`.