OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

doc: use "ACRN configurator" name in Overview, GSG 

Replaced "ACRN configuration editor" name with "ACRN configurator" in text and image to match the recently renamed acrn_configurator.py.

Note:

* The gsg_overview_image_sources.pptx file is the editable source file for overview_flow.png.

* I changed the name "configuration editor" to "ACRN configurator" in gsg_overview_image_sources.pptx and then saved as overview_flow.png.

* Although GitHub will say that I added gsg_overview_image_sources.pptx, this file already exists in master. I just edited it.

* GitHub may say that I removed overview_flow.png. In the PR, try clicking "Display the rich diff" icon. It will show that the existing image was replaced with the edited image.

Signed-off-by: amyreye <amy.reyes@intel.com>
This commit is contained in:
amyreye 2021-08-27 10:47:36 -07:00 committed by fitchbe
parent 7b19c8e878
commit 904f9e11b2
4 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/getting-started/getting-started.rst
View File

@ -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 `<http://127.0.0.1:5001/>`__
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

BIN
doc/getting-started/images/gsg_overview_image_sources.pptx
View File

Binary file not shown.

BIN
doc/getting-started/images/overview_flow.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 109 KiB

After

Width:  |  Height:  |  Size: 109 KiB

8
doc/getting-started/overview_dev.rst
View File

@ -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`.