Documentation for the sample app isn't ready for the public, so let's
not add it to the toctree yet (use the :orphan: role to stop Sphinx from
complaining about an unreferenced .rst file)
Tracked-On: #7820
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Add the ACRN Sample App document (README.rst) to the toctree
Convert the README.rst from Dos to Unix text file format
Tracked-On: #7820
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
- Update the Getting Started material with a DX-inspired rewrite and
simplification.
- Remove duplicate and out-of-date "Building from Source"
document, deferring to the new GSG.
- Add a development overview document.
- Move other GSGs to the advanced guides section.
- Update links in other documents to aim at the new GSG.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Signed-off-by: Amy Reyes <amy.reyes@intel.com>
Updates to the Getting Started Guide:
* Update title to simply be "Getting Started Guide"
* Simplify and remove instructions that are redundant
* Add a note explaining the difference between 'nuc11tnbi5' and
'nuc11tnhi5'
Tracked-On: #6225
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Update the ACRN documentation with regards to the supported HW:
* Remove outdated reference to Apollo Lake and Kaby Lake
* Re-order HW platforms in "Supported HW" to be consistent throughout
the document
* Use the '|copy|' and '|trade|' replacements
* Update the recommendation for creating nnon-existant $(BOARD).xml
Tracked-On: #6227
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Adding a new GSG contributed by ADLINK for installing an ACRN Industry
Scenario on their ROScube-I system.
Signed-off-by: ChenYing Kuo <chenying.kuo@adlinktech.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Remove some stray Clear Linux references, document labels, and update
the known issue filter patterns.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The hv parameter could be configured in GRUB menu, currently we support
"uart=" parameter to override uart settings.
The patch also has modifications on tutorial of using_grub.
Signed-off-by: Victor Sun <victor.sun@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Move the rt_industry GST into a tutorial for using Clear Linux as the
Service VM. Also drop a redirect to avoid 404 errors reference the
moved doc (redirect list maintained in conf.py)
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Change APL getting started guide to KBL getting started guide;
Merge some of the contents into preempt-rt getting started guide;
Move the modified kbl getting started guide to the behind of the configuration tutorials;
Fix issues for acrn_quick_setup.sh script.
Signed-off-by: lirui34 <ruix.li@intel.com>
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>
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>
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>
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>
Home page "button" links needed to be manually updated (because of the
raw html usage) after content around.
Move partition mode docs from try to develop persona pages.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
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>
David B. Kinder