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

29 lines
782 B
ReStructuredText
Raw Normal View History

doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
.. _getting_started:
doc: Reorganize documentation site content Take the existing ACRN technical documentation and reorganize its presentation to be persona and use-case based, in preparation for adding new scenario/use-case based architecture introduction and getting started documents. Introduce a more graphical home page and theme color tweaks. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 07:08:40 +08:00
Try using ACRN
##############
doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
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
development and target hardware, and then how to boot up the ACRN
doc: incorporate scenario-based doc update PR #3516 was submitted during a documentation reorganization and resulted in merge conflicts with files that no longer exist. We closed that PR and opened this one with those changes applied to the right files. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-03 05:08:07 +08:00
hypervisor and the `Clear Linux`_ Service VM and User VM on the Intel
doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
(EFI) platform.
.. _Clear Linux: https://clearlinux.org
doc: simplify navigation with restored doc org A few more tweaks to the site navigation since we moved the content back to its original folder structure. Remove the temporary "doc reorg in progress" banner. Add reference to hardware in the "try" section. Add link to the documentation home page in left nav pane. Add additional redirects to handle external links to moved content. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:03:24 +08:00
ACRN is supported on Apollo Lake and Kaby Lake Intel platforms,
as described in :ref:`hardware`.
Follow these getting started guides to give ACRN a try:
doc: reorganize documentation We've been expanding documentation, and now need to organize things a bit cleaner and separate content into new major folders: Introduction, Getting Started, User Guides, Developer Guides, Tutorials, and Release notes.. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-06-28 22:55:57 +08:00
.. toctree::
:maxdepth: 1
doc: additional doc navigation restructuring Adjust doc navigation organization based on additional feedback. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 12:12:59 +08:00
reference/hardware
doc: simplify navigation with restored doc org A few more tweaks to the site navigation since we moved the content back to its original folder structure. Remove the temporary "doc reorg in progress" banner. Add reference to hardware in the "try" section. Add link to the documentation home page in left nav pane. Add additional redirects to handle external links to moved content. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:03:24 +08:00
getting-started/apl-nuc
getting-started/up2
doc: Use out-of-the-box image to boot ACRN RTVM This tutorial describes how to generate, deploy OOTB Service VM RTVM image so that all of the users are able to use ACRN, boot RTVM immediately after installation without any configuration or modification. Signed-off-by: lirui34 <ruix.li@intel.com>
2019-09-24 23:47:57 +08:00
getting-started/acrn_ootb
doc: simplify navigation with restored doc org A few more tweaks to the site navigation since we moved the content back to its original folder structure. Remove the temporary "doc reorg in progress" banner. Add reference to hardware in the "try" section. Add link to the documentation home page in left nav pane. Add additional redirects to handle external links to moved content. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:03:24 +08:00
getting-started/building-from-source
doc: move the "Building ACRN in Docker" user guide Move the "Building ACRN in Docker" guide to the "Try using ACRN" section to be more prominently visible. Reference it from the main "Build ACRN from Source" user guide. Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-10-03 14:33:54 +08:00
getting-started/building_acrn_in_docker
doc: Add introduction for using Preempt_RT VM with Industry scenario This tutorial is introducing how to build service vm, preempt_rt kernel and industry scenario hypervisor; Update built kernel and launch the preempt_rt vm. Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-14 14:07:43 +08:00
getting-started/rt_industry