doc: fix renaming of getting started guide

Tweak references to account for renaming the getting started guide in
PR #6226 and create a redirect link from the previous filename.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-06-21 11:35:59 -07:00 committed by David Kinder
parent 6b6efed7eb
commit f3dd19dea7
8 changed files with 16 additions and 28 deletions

View File

@ -389,22 +389,6 @@ html_redirect_pages = [
('user-guides/index', 'develop'), ('user-guides/index', 'develop'),
('hardware', 'reference/hardware'), ('hardware', 'reference/hardware'),
('release_notes', 'release_notes/index'), ('release_notes', 'release_notes/index'),
('getting-started/rt_industry', 'tutorials/cl_servicevm'), ('getting-started/rt_industry', 'getting_started/getting_started'),
('tutorials/acrn-dm_QoS', 'nocl'), ('getting-started/rt_industry_ubuntu', 'getting_started/getting_started'),
('tutorials/acrn_ootb', 'nocl'),
('tutorials/agl-vms', 'nocl'),
('tutorials/building_acrn_in_docker', 'nocl'),
('tutorials/building_uos_from_clearlinux', 'nocl'),
('tutorials/cl_servicevm', 'nocl'),
('tutorials/enable_laag_secure_boot', 'nocl'),
('tutorials/increase_uos_disk_size', 'nocl'),
('tutorials/kbl-nuc-sdc', 'nocl'),
('tutorials/open_vswitch', 'nocl'),
('tutorials/running_deb_as_serv_vm', 'nocl'),
('tutorials/sign_clear_linux_image', 'nocl'),
('tutorials/static-ip', 'nocl'),
('tutorials/up2', 'nocl'),
('tutorials/using_celadon_as_uos', 'nocl'),
('tutorials/using_sbl_on_up2', 'nocl'),
('tutorials/using_ubuntu_as_sos', 'nocl'),
] ]

View File

@ -1,3 +1,4 @@
.. _gsg:
.. _rt_industry_ubuntu_setup: .. _rt_industry_ubuntu_setup:
Getting Started Guide Getting Started Guide
@ -29,7 +30,8 @@ Verified Version
- HW: Intel NUC 11 Pro Kit NUC11TNHi5 (`NUC11TNHi5 - HW: Intel NUC 11 Pro Kit NUC11TNHi5 (`NUC11TNHi5
<https://ark.intel.com/content/www/us/en/ark/products/205594/intel-nuc-11-pro-kit-nuc11tnhi5.html>`_) <https://ark.intel.com/content/www/us/en/ark/products/205594/intel-nuc-11-pro-kit-nuc11tnhi5.html>`_)
.. note:: This NUC is based on the `NUC11TNBi5 board <https://ark.intel.com/content/www/us/en/ark/products/205596/intel-nuc-11-pro-board-nuc11tnbi5.html>`_. .. note:: This NUC is based on the
`NUC11TNBi5 board <https://ark.intel.com/content/www/us/en/ark/products/205596/intel-nuc-11-pro-board-nuc11tnbi5.html>`_.
The ``BOARD`` parameter that is used to build ACRN for this NUC is therefore ``nuc11tnbi5``. The ``BOARD`` parameter that is used to build ACRN for this NUC is therefore ``nuc11tnbi5``.
Prerequisites Prerequisites
@ -248,6 +250,8 @@ Install the Service VM Kernel and Modules
$ sudo make modules_install $ sudo make modules_install
$ sudo cp arch/x86/boot/bzImage /boot/bzImage $ sudo cp arch/x86/boot/bzImage /boot/bzImage
.. _gsg_update_grub:
Update Grub for the Ubuntu Service VM Update Grub for the Ubuntu Service VM
===================================== =====================================

View File

@ -70,7 +70,7 @@ release version and may not work as expected on later ACRN releases.
https://up-shop.org/home/270-up-squared.html https://up-shop.org/home/270-up-squared.html
For general instructions setting up ACRN on supported hardware platforms, visit the :ref:`rt_industry_ubuntu_setup` page. For general instructions setting up ACRN on supported hardware platforms, visit the :ref:`gsg` page.
.. list-table:: Supported Target Platforms .. list-table:: Supported Target Platforms
:widths: 20 20 12 5 5 :widths: 20 20 12 5 5

View File

@ -28,7 +28,7 @@ Verified Version
Prerequisites Prerequisites
************* *************
Follow :ref:`these instructions <rt_industry_ubuntu_setup>` to set up Follow :ref:`these instructions <gsg>` to set up
Ubuntu as the ACRN Service VM. Ubuntu as the ACRN Service VM.
Supported Hardware Platform Supported Hardware Platform

View File

@ -169,7 +169,7 @@ Prepare for Service VM Kernel and rootfs
The service VM can run Ubuntu or other Linux distributions. The service VM can run Ubuntu or other Linux distributions.
Instructions on how to boot Ubuntu as the Service VM can be found in Instructions on how to boot Ubuntu as the Service VM can be found in
:ref:`rt_industry_ubuntu_setup`. :ref:`gsg`.
The Service VM kernel needs to be built from the ``acrn-kernel`` repo, and some changes The Service VM kernel needs to be built from the ``acrn-kernel`` repo, and some changes
to the kernel ``.config`` are needed. to the kernel ``.config`` are needed.
@ -195,7 +195,7 @@ guests on the Service VM:
CONFIG_ACRN_GUEST=y CONFIG_ACRN_GUEST=y
After you made these configuration modifications, build and install the kernel After you made these configuration modifications, build and install the kernel
as described in :ref:`rt_industry_ubuntu_setup`. as described in :ref:`gsg`.
Launch a Nested Guest VM Launch a Nested Guest VM

View File

@ -44,7 +44,7 @@ kernels are loaded as multiboot modules. The ACRN hypervisor, Service
VM, and Pre-Launched RT kernel images are all located on the NVMe drive. VM, and Pre-Launched RT kernel images are all located on the NVMe drive.
We recommend installing Ubuntu on the NVMe drive as the Service VM OS, We recommend installing Ubuntu on the NVMe drive as the Service VM OS,
which also has the required GRUB image to launch Pre-Launched RT mode. which also has the required GRUB image to launch Pre-Launched RT mode.
Refer to :ref:`rt_industry_ubuntu_setup`, to Refer to :ref:`gsg`, to
install Ubuntu on the NVMe drive, and use grub to launch the Service VM. install Ubuntu on the NVMe drive, and use grub to launch the Service VM.
Install Pre-Launched RT Filesystem on SATA and Kernel Image on NVMe Install Pre-Launched RT Filesystem on SATA and Kernel Image on NVMe
@ -83,7 +83,7 @@ Add Pre-Launched RT Kernel Image to GRUB Config
The last step is to modify the GRUB configuration file to load the Pre-Launched The last step is to modify the GRUB configuration file to load the Pre-Launched
kernel. (For more information about this, see :ref:`Update Grub for the Ubuntu Service VM kernel. (For more information about this, see :ref:`Update Grub for the Ubuntu Service VM
<rt_industry_ubuntu_setup>`.) The grub config file will look something <gsg_update_grub>` section in the :ref:`gsg`.) The grub config file will look something
like this: like this:
.. code-block:: none .. code-block:: none

View File

@ -18,7 +18,7 @@ Prerequisites
#. Refer to the :ref:`ACRN supported hardware <hardware>`. #. Refer to the :ref:`ACRN supported hardware <hardware>`.
#. For a default prebuilt ACRN binary in the end-to-end (E2E) package, you must have 4 #. For a default prebuilt ACRN binary in the end-to-end (E2E) package, you must have 4
CPU cores or enable "CPU Hyper-threading" in order to have 4 CPU threads for 2 CPU cores. CPU cores or enable "CPU Hyper-threading" in order to have 4 CPU threads for 2 CPU cores.
#. Follow the :ref:`rt_industry_ubuntu_setup` to set up the ACRN Service VM #. Follow the :ref:`gsg` to set up the ACRN Service VM
based on Ubuntu. based on Ubuntu.
#. This tutorial is validated on the following configurations: #. This tutorial is validated on the following configurations:
@ -75,7 +75,7 @@ to automate the Kata Containers installation procedure.
$ sudo cp build/misc/tools/acrnctl /usr/bin/ $ sudo cp build/misc/tools/acrnctl /usr/bin/
.. note:: This assumes you have built ACRN on this machine following the .. note:: This assumes you have built ACRN on this machine following the
instructions in the :ref:`rt_industry_ubuntu_setup`. instructions in the :ref:`gsg`.
#. Modify the :ref:`daemon.json` file in order to: #. Modify the :ref:`daemon.json` file in order to:

View File

@ -11,7 +11,7 @@ ACRN hypervisor.
ACRN Service VM Setup ACRN Service VM Setup
********************* *********************
Follow the steps in this :ref:`rt_industry_ubuntu_setup` to set up ACRN Follow the steps in this :ref:`gsg` to set up ACRN
based on Ubuntu and launch the Service VM. based on Ubuntu and launch the Service VM.
Setup for Using Windows as the Guest VM Setup for Using Windows as the Guest VM