Commit Graph

621 Commits

Author SHA1 Message Date
Deb Taylor
add89b51ec Remove "or newer" reference to ensure that users know ACRN 1.2 requires ONLY Clear Linux OS version 30690.
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-09-06 18:44:17 -04:00
Deb Taylor
6ca4095d9c Update pages with missing links
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-28 09:37:15 -07:00
lirui34
48d06da743 doc: Add three known issues to the v1.2 release notes
Add three known issues to the v1.2 release notes.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-23 19:50:42 +08:00
Yan, Like
5dd07f7113 doc: remove "pincpu" option description
Update the document becase the "pincpu" option is removed.

Tracked-On: #3600
Signed-off-by: Yan, Like <like.yan@intel.com>
2019-08-22 13:06:28 +08:00
Victor Sun
1399f47987 doc: update partition desc for up2 board
modify partition desc table of up2 board to make it consistent with
launch uos script.

Signed-off-by: Lei Lu <leix.lu@intel.com>
Signed-off-by: Victor Sun <victor.sun@intel.com>
2019-08-22 09:10:38 +08:00
David B. Kinder
4d4c4e7b68 doc: remove modernizr.min.js
modernizr.min.js is no longer used by Sphinx's rtd theme and is causing
some browsers to have a noticable flash when pages are loaded. While we
can't easily remove it from the RTD theme, we can replace the script
with an empty file instead.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-16 15:36:46 -07:00
David B. Kinder
5b5efe7193 doc: add v1.2 to the release navigation picker
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:50:33 -07:00
David B. Kinder
7131b19f4a doc: remove references to 2.0 in intro
While we internally call the "new" ACRN architecture 2.0, it could be
confusing to users since we also are calling the upcoming release v1.2
and there is no 2.0 release yet.  Remove references to 2.0 in the
introduction.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:41:23 -07:00
lirui34
27b7cc23ea doc: Release Notes v1.2
Add release notes v1.2

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-15 09:23:40 -07:00
David B. Kinder
e77d1d7343 doc: add new scenario-based intro
Add the scenario configurations to the ACRN introduction.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-15 09:16:24 -07:00
Deb Taylor
a5647e9edf Content edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-08-14 21:09:49 -07:00
David B. Kinder
9144c56771 doc: incorporate new scenario-based hardware doc
Changing from just describing the supported hardware to a new hardware
support matrix based on the usage scenarios.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-13 18:30:25 -07:00
yunzha4x
bbf4df7bf7 doc: update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
yunzha4x
02073a2d72 doc: update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
yunzha4x
b06c84ba1f doc:update Getting started guide for Intel NUC software setup
Signed-off-by: yunzha4x <yunx.zhang@intel.com>
2019-08-13 14:59:00 -07:00
Lei Lu
bf1a162c3e doc: update Using SBL on UP2 Board
1. The origin clearlinux version 29070 in this doucment example is not
   workable with acrn latest code, update the clearlinux version.
2. Replace the sos_console_login.png with vm_console_login.png

Signed-off-by: Lei Lu <leix.lu@intel.com>
2019-08-13 14:30:16 -07:00
Shiqing Gao
c3001e61a2 doc: add limitation for UEFI services
- add limitation for UEFI services

Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-08-13 14:29:20 -07:00
Deb Taylor
13de9a4cf6 Formatting for new Hardware Support page 2019-08-09 16:58:20 -07:00
lirui34
70e1e8d154 doc: hybrid mode scenario introduction
Add introduction about how to enable hybrid mode scenario.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-09 16:32:13 -07:00
Li, Fei1
adbaaaf6cb hv: vpci: rename ptdev_config to pci_dev_config
pci_dev_config in VM configure stores all the PCI devices for a VM. Besides PT
devices, there're other type devices, like virtual host bridge. So rename ptdev
to pci_dev for these configure.

Tracked-On: #3475
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-08-06 11:51:02 +08:00
David B. Kinder
70fdde4230 doc: add the SDC2 scenario doc into the navigation
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 17:24:54 -07: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
9580a2131b doc: apply edits to SDC2 scenario doc
Update merged PR #3463 with format and wording improvements.
(Not linked yet into the document navigation)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 12:59:00 -07:00
Tonny Tzeng
0ab14fab39 doc: adding guide to launch 2 Linux UOSes using SDC2 scenario
Tracked-On: #3462
Signed-off-by: Tonny Tzeng <tonny.tzeng@intel.com>
Reviewed-by: Fuzhong Liu <fuzhong.liu@intel.com>
Reviewed-by: Nanlin Xie <nanlin.xie@intel.com>
2019-08-02 10:27:02 -07:00
David B. Kinder
0085348f36 doc: update v1.0.1 release notes
Fix some wording, table formatting, and links to issues and commits from
the original PR #3515

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 10:23:13 -07:00
lirui34
3b00ab160e doc: release notes v1.0.1
Add release notes v1.0.1

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-08-02 09:55:19 -07:00
David B. Kinder
abd8b710a4 doc: improve CSS for home page grid
Update the ACRN logo size to remove specifics in the CSS.  (Grid images
should be ~100px high for the grid.)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 09:53:34 -07:00
David B. Kinder
a1cc860d5d doc: fix image proportions on home page for ie
The ACRN icon on the new graphical home page looked fine with firefox,
edge, and chrome browsers, but not on IE.  This PR fixes that

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-02 07:56:42 -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
David B. Kinder
e2d3653976 doc: continue doc restructuring
Changing the folder structure will cause too many broken links for
external references (from other sites). So, let's put the content back
where it was before the reorg, and instead use the new persona-based
navigation to point to documents in the original locations.

Also, introduce redirects for some documents that no longer exits.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-08-01 14:07:22 -07:00
David B. Kinder
11d4f4159f 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-07-31 18:29:22 -07:00
lirui34
52618d0a23 doc: Update WaaG tutorial launch script and OVMF binary
Change WaaG launch script to the default ``launch_win.sh``,
and also provide one OVMF.fd binary in order to launch WaaG.
Change SOS / UOS to Service VM / Guest VM.

Signed-off-by: lirui34 <ruix.li@intel.com>
2019-07-31 13:08:05 -07:00
Yang, Yu-chu
d1c8a514f6 doc: Add ovmf option description
Added ovmf NV storage writeback option "w" description and usage example.

Signed-off-by: Yang, Yu-chu <yu-chu.yang@intel.com>
2019-07-29 20:36:43 -07:00
David B. Kinder
8ee1615e51 doc: fix issues from moving tools to misc/tools
PR #3483 cleaned up the project root folder and moved stuff that was in
/tools into a new /misc folder.  There were a few references to
the old /tools folder missed in that update, addressed in this PR.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-29 14:23:04 -07:00
Deb Taylor
f44517c772 final edits 3
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
879d01319f final edit 2
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
1ccb902048 final edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
d485ed86c0 edits
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
28e49ac183 more edits 2019-07-29 13:58:41 -07:00
Deb Taylor
cc2714eee9 edits from David review
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
7ee02d8eb0 Image resize
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
87162e8b3e Making three images even smaller
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
42960ddcc8 Adjust picture size for SGX
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Deb Taylor
d0f7563d89 Corrected images and formatting
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
deb-intel
ce7a126f7e Added 3 SGX images 2019-07-29 13:58:41 -07:00
Deb Taylor
01504ecf93 Initial SGX Virt doc upload
Signed-off-by: Deb Taylor <deb.taylor@intel.com>
2019-07-29 13:58:41 -07:00
Terry Zou
a9c38a5cfb HV:Acrn-hypvervisor Root Directory Clean-up and create misc/ folder for Acrn daemons, services and tools.
This patch is to clean-up acrn-hypervisor root directory, targt only 5 folders under acrn-hypervisor:1.hypervisor,2.devicemodel,3.misc,4.doc,5.build

Tracked-On: #3482
Signed-off-by: Terry Zou <terry.zou@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2019-07-29 22:58:24 +08:00
David B. Kinder
9fef51abf9 doc: organize release notes into a folder
Unclutter the main doc folder by putting all the release notes
into a separate folder.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-07-24 09:47:24 -07:00