Commit Graph

365 Commits

Author SHA1 Message Date
Kaige Fu 61a9ca2053 Documentation: Add tutorial about how to use partition mode on UP2
This patch adds tutorial about all the steps you need to take in order to use
partition mode with ACRN hypervisor on UP2.

Tracked-On: #1160
Signed-off-by: Kaige Fu <kaige.fu@intel.com>
2018-10-25 10:14:36 -07:00
Geoffroy Van Cutsem 30c2901546 Documentation: typo in Ubuntu tutorial and additional note
Fix one typo (in a command) in the tutorial entitled "Using
Ubuntu as the Service OS".

Add a note explaining that a script may have to be adjusted
based on the HW set-up (network interface name).

Tracked-On: #1502

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-18 14:56:47 -07:00
Geoffroy Van Cutsem 2b449680ff Documentation: minor update to the tutorial about Ubuntu as SOS
Minor update to the tutorial on how to use Ubuntu as the Service OS
with ACRN. Specifically, the instructions for making the Grub menu
visible at boot time now involved modify the /etc/default/grub file
and not the /boot/grub/grub.cfg as before.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-10-17 05:54:49 -07:00
David B. Kinder 68ce114b43 doc: add tool for verifying installed doc tools
Added a python script that displays versions of doc building tools
(e.g., doxygen, breathe, sphinx) to help verify doc building environment
is properly set up (can help doc building problem diagnostic, as shown
in issue #1333

Update doc build documentation to reference this script.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-26 13:34:25 -07:00
David B. Kinder 23cf8079e7 doc: update tagged release doc build instructions
Update the doc build instructions to include how to update the version
navigation selector (bottom of the left nav panel), and make commands
for building and publishing specific tagged releases (e.g., 0.2)

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-24 13:43:03 -07:00
David B. Kinder d32ef9b1eb doc: fix doc misspellings
fix misspellings in .rst files missed during regular reviews

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-09-05 16:06:19 -07:00
ailin,yang f4513f903d update to fix format issue of ReST
accept the feedback from David
align the content to meet the ReST
2018-08-16 09:02:15 -07:00
ailin,yang 5a6ee3f3b3 update doc -Using Ubuntu as the Service OS
1, update contents to align latest acrn and clear Linux release
2, change /etc/grub.d/40_custom file to specify 'insmod ext2', not 'insmod ext4' and github issue- https://github.com/projectacrn/acrn-hypervisor/issues/707
3, add tap device and network sharing enabling script as the example for ubuntu SOS
4, add several tips for new user to use ubuntu as the SOS

Signed-off-by: ailun258 ailin.yang@intel.com
2018-08-16 09:02:15 -07:00
David B. Kinder 3abfdbab72 doc: add script for syncing acrn-kernel for API gen
API doc generation includes kernel components provided by ACRN that live
in the acrn-kernel repo (not the acrn-hypervisor repo). We need to
include fetching the latest acrn-kernel sources when we do doc
generation, and update the documentation to mention we now need the
acrn-kernel repo as a sibling folder for the acrn-hypervisor repo
contents.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-24 17:20:43 -07:00
David B. Kinder e04255822a doc: update GSG for v0.1, add console code-block
Console screen shots are hard to maintain, so use the
.. code-block:: console directive to show terminal console-like display
(black background with white text)

Change existing .. code-block:: console uses to .. code-block: none

Replace screen-shot images in apl-nuc getting started guide with
text-based console display.

Update apl-nuc GSG content with v0.1 changes

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-16 13:51:28 -07:00
Geoffroy Van Cutsem dc135bd501 Documentation: tutorial on how to use Ubuntu as the SOS
Add a tutorial explaining how to use Ubuntu as the Service OS
running on ACRN and providing all the device sharing services
(devicemodel) and tools to manage virtual machines.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
Signed-off-by: Ailin Yang <ailin.yang@intel.com>
2018-07-09 18:11:43 +08:00
David B. Kinder 05d2558f9f doc: move graphviz material to developer-guides
Rather than a "tutorial", it was suggested to move the graphviz
information to the devleoper-guides, along with the documentation
guidelines.  Makes sense.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-07-03 09:48:19 -07:00
Miguel Bernal Marin 5d94e9bbf0 Documentation: fix set up a static IP tutorial
Clear Linux is a stateless system, also systemd.

https://clearlinux.org/features/stateless

This tutorial advice to modify a file in /usr/lib which is used by vendors.
Instead of that, this commit advice to use the local administration
network directory at /etc/systemd/network.

See more reference using:

man systemd.network

Fixes: 25eae47836 ("Documentation: add tutorial to set up a static IP address")
Signed-off-by: Miguel Bernal Marin <miguel.bernal.marin@linux.intel.com>
2018-07-03 09:47:23 -07:00
Geoffroy Van Cutsem 25eae47836 Documentation: add tutorial to set up a static IP address
Add a tutorial on how to change the default configuration that
uses DHCP and assign a static IP address to the system.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-06-29 10:48:36 -07:00
David B. Kinder 3965593df6 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:36:13 -07:00