Commit Graph

21 Commits

Author SHA1 Message Date
David B. Kinder 50094fb88b doc: DX update for GSG
- 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>
2021-08-20 07:53:18 -07:00
Geoffroy Van Cutsem 6b6efed7eb doc: updates to the Getting Started Guide
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>
2021-06-21 11:24:12 -07:00
Geoffroy Van Cutsem 8f8fe5c18c doc: update the "Supported Hardware" document
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>
2021-06-21 07:57:00 -07:00
David B. Kinder 2571314d77 doc: add ROScube GSG
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>
2020-12-08 11:08:58 -08:00
David B. Kinder ad8a0cf737 doc: doc cleanup for v2.3 release
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>
2020-12-01 15:37:06 -08:00
David B. Kinder e74cf71eb7 doc: spelling and grammar fixes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2020-08-20 08:09:21 -07:00
Victor Sun 780c87d9da doc: add hv parameter usage
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>
2020-06-17 21:10:42 -07:00
Victor Sun 5119fa0673 doc: add using grub tutorial
The GRUB could be used to boot ACRN hypervisor in direct boot mode.

Signed-off-by: Victor Sun <victor.sun@intel.com>
2020-06-17 21:10:42 -07:00
David B. Kinder 764d7c1332 doc: rename rt_industry GSG
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>
2020-06-04 08:10:02 -07:00
Deb Taylor acbc6848fc Initial GSG for ARCN industry Scenario with Unbuntu Service VM
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-06-03 17:52:31 -04:00
Deb Taylor b514eba9d6 Doc: Modify Getting Started and Advanced Guides sections (navigation)
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-04-24 13:03:54 -04:00
Deb Taylor 9a85e27430 Doc: Re-org documentation to improve user experience; see Nav Bar
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2020-03-12 21:54:36 -04:00
lirui34 705ba86da2 doc: clean up the docs in try using acrn table.
Move acrn_ootb / building_acrn_in_docker / up2 gsg to the
develop using acrn guide;

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-11-08 08:44:22 -08:00
lirui34 f835fdef05 doc: Remove apl gsg and merge contents into rt gsg
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>
2019-11-05 15:09:49 -05:00
Geoffroy Van Cutsem 6f7ba36ea0 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-14 17:33:20 -04:00
lirui34 018fed2c21 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-09-28 04:54:37 -04:00
lirui34 7f42edcb0b 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-25 15:36:45 -04:00
David B. Kinder f0ecf8291f 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-02 15:38:23 -07:00
David B. Kinder cd232f4442 doc: fix broken links after content reorg
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>
2019-08-02 07:34:25 -07:00
David B. Kinder 0d07dad5cb 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-01 21:30:22 -07:00
David B. Kinder 2ccd652607 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-01 16:22:50 -07:00