Doc: Re-org documentation to improve user experience; see Nav Bar
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
This commit is contained in:
parent
b62d439bf1
commit
9a85e27430
|
@ -1,7 +1,7 @@
|
||||||
.. _contribute_acrn:
|
.. _contribute_acrn:
|
||||||
|
|
||||||
Contribute to ACRN
|
Developer Reference
|
||||||
##################
|
###################
|
||||||
|
|
||||||
Here's where you'll find details about ACRN's high-level design and
|
Here's where you'll find details about ACRN's high-level design and
|
||||||
design principles, along with guidelines followed by the
|
design principles, along with guidelines followed by the
|
||||||
|
@ -27,8 +27,8 @@ also find details about specific architecture topics.
|
||||||
developer-guides/VBSK-analysis
|
developer-guides/VBSK-analysis
|
||||||
|
|
||||||
|
|
||||||
Contributing Guides
|
Contribute Guides
|
||||||
*******************
|
*****************
|
||||||
|
|
||||||
As an open-source project, we welcome and encourage the community to
|
As an open-source project, we welcome and encourage the community to
|
||||||
submit patches for code, documentation, tests, and more, directly to the
|
submit patches for code, documentation, tests, and more, directly to the
|
||||||
|
@ -45,15 +45,12 @@ the project.
|
||||||
developer-guides/graphviz
|
developer-guides/graphviz
|
||||||
tutorials/docbuild
|
tutorials/docbuild
|
||||||
|
|
||||||
.. _tools:
|
API Documentation
|
||||||
|
*****************
|
||||||
Tools
|
|
||||||
*****
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
misc/tools/acrn-crashlog/README
|
api/index
|
||||||
misc/tools/**
|
|
||||||
misc/acrn-manager/**
|
|
||||||
|
|
|
@ -1,38 +1,41 @@
|
||||||
.. _develop_acrn:
|
.. _develop_acrn:
|
||||||
|
|
||||||
Develop using ACRN
|
Advanced Guides
|
||||||
##################
|
###############
|
||||||
|
|
||||||
|
|
||||||
Configuration Tools
|
Tools
|
||||||
*******************
|
*****
|
||||||
|
|
||||||
|
**Configuration Tools**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
tutorials/acrn_configuration_tool
|
||||||
|
reference/kconfig/index
|
||||||
|
user-guides/acrn-dm-parameters
|
||||||
|
|
||||||
|
.. _tools:
|
||||||
|
|
||||||
|
**Runtime Tools**
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
misc/tools/acrn-crashlog/README
|
||||||
|
misc/tools/**
|
||||||
|
misc/acrn-manager/**
|
||||||
|
|
||||||
|
Service VM Tutorials
|
||||||
|
********************
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
tutorials/acrn_configuration_tool
|
tutorials/using_ubuntu_as_sos
|
||||||
|
tutorials/running_deb_as_serv_vm
|
||||||
Configuration Tutorials
|
|
||||||
***********************
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
tutorials/up2
|
|
||||||
tutorials/increase-uos-disk-size
|
|
||||||
tutorials/sign_clear_linux_image
|
|
||||||
tutorials/static-ip
|
|
||||||
tutorials/debug
|
|
||||||
tutorials/using_partition_mode_on_nuc
|
|
||||||
tutorials/using_partition_mode_on_up2
|
|
||||||
tutorials/using_sdc2_mode_on_nuc
|
|
||||||
tutorials/using_hybrid_mode_on_nuc
|
|
||||||
tutorials/realtime_performance_tuning
|
|
||||||
tutorials/kbl-nuc-sdc
|
|
||||||
tutorials/enable_laag_secure_boot
|
|
||||||
tutorials/building_acrn_in_docker
|
|
||||||
tutorials/acrn_ootb
|
|
||||||
tutorials/run_kata_containers
|
|
||||||
|
|
||||||
User VM Tutorials
|
User VM Tutorials
|
||||||
*****************
|
*****************
|
||||||
|
@ -50,15 +53,6 @@ User VM Tutorials
|
||||||
tutorials/running_deb_as_user_vm
|
tutorials/running_deb_as_user_vm
|
||||||
tutorials/running_ubun_as_user_vm
|
tutorials/running_ubun_as_user_vm
|
||||||
|
|
||||||
Service VM Tutorials
|
|
||||||
********************
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
tutorials/using_ubuntu_as_sos
|
|
||||||
tutorials/running_deb_as_serv_vm
|
|
||||||
|
|
||||||
Enable ACRN Features
|
Enable ACRN Features
|
||||||
********************
|
********************
|
||||||
|
|
||||||
|
@ -77,3 +71,34 @@ Enable ACRN Features
|
||||||
tutorials/waag-secure-boot
|
tutorials/waag-secure-boot
|
||||||
tutorials/enable_s5
|
tutorials/enable_s5
|
||||||
tutorials/cpu_sharing
|
tutorials/cpu_sharing
|
||||||
|
|
||||||
|
Debug
|
||||||
|
*****
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
tutorials/debug
|
||||||
|
tutorials/realtime_performance_tuning
|
||||||
|
|
||||||
|
Additional Tutorials
|
||||||
|
********************
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
tutorials/up2
|
||||||
|
tutorials/increase-uos-disk-size
|
||||||
|
tutorials/sign_clear_linux_image
|
||||||
|
tutorials/static-ip
|
||||||
|
tutorials/using_partition_mode_on_nuc
|
||||||
|
tutorials/using_partition_mode_on_up2
|
||||||
|
tutorials/using_sdc2_mode_on_nuc
|
||||||
|
tutorials/using_hybrid_mode_on_nuc
|
||||||
|
tutorials/kbl-nuc-sdc
|
||||||
|
tutorials/enable_laag_secure_boot
|
||||||
|
tutorials/building_acrn_in_docker
|
||||||
|
tutorials/acrn_ootb
|
||||||
|
tutorials/run_kata_containers
|
||||||
|
user-guides/acrn-shell
|
||||||
|
user-guides/kernel-parameters
|
|
@ -81,7 +81,6 @@ license.
|
||||||
try
|
try
|
||||||
develop
|
develop
|
||||||
contribute
|
contribute
|
||||||
reference/index
|
|
||||||
release_notes/index
|
release_notes/index
|
||||||
asa
|
asa
|
||||||
faq
|
faq
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.. _learn_acrn:
|
.. _learn_acrn:
|
||||||
|
|
||||||
Learn about ACRN
|
What is ACRN
|
||||||
################
|
############
|
||||||
|
|
||||||
ACRN is supported on Apollo Lake and Kaby Lake Intel platforms,
|
ACRN is supported on Apollo Lake and Kaby Lake Intel platforms,
|
||||||
as described in :ref:`hardware`.
|
as described in :ref:`hardware`.
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
:orphan:
|
||||||
|
|
||||||
.. _reference:
|
.. _reference:
|
||||||
|
|
||||||
Developer references
|
Developer references
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
.. _getting_started:
|
.. _getting_started:
|
||||||
|
|
||||||
Try using ACRN
|
Getting Started
|
||||||
##############
|
###############
|
||||||
|
|
||||||
After reading the :ref:`introduction`, use these guides to get started
|
After reading the :ref:`introduction`, use these guides to get started
|
||||||
using ACRN in a reference setup. We'll show how to set up your
|
using ACRN in a reference setup. We'll show how to set up your
|
||||||
|
|
Loading…
Reference in New Issue