Commit Graph

1691 Commits

Author SHA1 Message Date
Geoffroy Van Cutsem cd72305368 getting_started: make instructions more specific
Make the Getting Started Guide instructions more specific and
comprehensive for Clear Linux version 21260 (version of reference)

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-05-15 17:19:36 +08:00
David B. Kinder a5e32731ad doc: update getting started images
New (and cleaner) images for the getting started guide.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:36 +08:00
David B. Kinder 3b86c9710e doc: improvements for sphinx generation
Handle version retrieval better when comments are present.
Add warning if Sphinx theme (read_the_docs) is missing.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:36 +08:00
Geoffroy Van Cutsem 637a79da07 Getting Started Guide: add instructions for other OSs
Add instructions on how to build the hypervisor and device model
on other operating systems such as Ubuntu/Debian, Fedora/doc/Redhat
and CentOS.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-05-15 17:19:36 +08:00
David B. Kinder c8d2cdccda doc: update project documentation LICENSE
Per Project ACRN governance, documentation is under a Creative Commons
Attribution 4.0 International License (CC BY 4.0).  This patch updates
this information, and adds a tagline to documentation mentioning this
license.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David Kinder 4ecb849a71 Delete LICENSE 2018-05-15 17:19:35 +08:00
David B. Kinder 0dc93a5281 doc: filter known issues
make the doc build process quiet and add filtering of known (Sphinx)
issues.  Scripting comes from the open source Zephyr project.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder b170e295a7 doc: general edit for typos
Fix typos and misspellings, and tweak CSS for spacing before lists.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder b84aa9fc87 doc: fix doxy for hiding internal symbols
Docyten syntax for EXCLUDE_SYMBOLS is with spaces for separator,
not commas.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder c3bef4e1d6 doc: update GSG instructions
Add some clarity edits and fix misspellings

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
ailun258 8b4378e9c0 update to support latest image
changed 3 to support latest image release
1, deleted one bundle installation -os-clr-on-clr-dev
2, changed the default configuration file path to /usr/share/acrn/demo
3, after installed service os bundle, all the configuration files and scripts were installed, no need to download manually any more
2018-05-15 17:19:35 +08:00
David B. Kinder c48f757e6d doc: Update publish process in Makefile
Simplify the publishing process to projectacrn.github.io by making
commits directly to the projectacrn/projectacrn.github.io repo (rather
than to a personal repo, doing a PR, and processing the PR).  This
eliminates manual processing in an otherwise automated publishing
process:  PR reviews aren't needed for this step.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
Geoffroy Van Cutsem 52f49c9807 getting-started-guide: update Clear Linux version to min required
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder af66e95112 doc: remove "under construction" tagline
we're getting close...

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder da54bde3a7 doc: add Getting Started Guide
Initial version of Getting Started Guide doc (and images).
Need to replace images with better ones.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder c6218bd1dd doc: fix misspellings
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder fe28d360b0 doc: update release notes
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder d118652165 doc: fix error in contributing guidelines
fix typo

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder 48df39c8fd doc: add 0.1 release notes
Initial version of 0.1 release notes, plus a CSS tweak for tables

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
Rraghuveer ff45e24732 Update contribute.rst 2018-05-15 17:19:35 +08:00
David B. Kinder b9b20fa6a8 doc: add developer primer
Developer Primer and images, and a tweak to figure formatting
also renamed from Hypervisor Primer to just Developer Primer since the
doc talks about Device Model too.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David B. Kinder df5c261362 doc: update display of RC version
Change display of RC_VERSION on documents to be
  vMAJOR_VERSION.MINOR_VERSION-rcRC_VERSION
if RC_VERSION is non-zero, otherwise only
  vMAJOR_VERSION.MINOR_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-15 17:19:35 +08:00
David Kinder 67e02ceb14 Create LICENSE 2018-05-11 14:44:29 +08:00
David B. Kinder e62ede0d9f doc: add CODEOWNERS for assigning reviewers
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
David B. Kinder b03cda69d1 doc: update build process to get RC_VERSION
Doc version tracking with acrn-hypervisor version now to be
MAJOR_VERSION . MINOR_VERSION . RC_VERSION

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
David B. Kinder a98a45ea4f doc: fix formatting errors in contribution guide
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
Rraghuveer 4609f972c5 Update contribute.rst 2018-05-11 14:44:29 +08:00
Rraghuveer 1c16ff9fc6 Update contribute.rst 2018-05-11 14:44:29 +08:00
David B. Kinder ba121731b2 doc: add Technical intro doc
Add the "Introduction of Project Acorn" doc.

Also adds improvements to the doc generation processes, content styles,
removed doxygen-generated API material.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:29 +08:00
Rraghuveer f83411fa30 Update contribute.rst 2018-05-11 14:44:28 +08:00
Rraghuveer 48c1f2a863 Update contribute.rst 2018-05-11 14:44:28 +08:00
David B. Kinder 927dac7000 add in progress
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:28 +08:00
David B. Kinder b966397914 add supported hardware
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder 4d102928fc doc: set version to 0.1
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder 30a65876ca doc: add favicon
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder 8d7a449c55 doc: fix source file fetching and cleaning
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder 4c941d5e5b improve automation
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder dce61618dc doc: organizational and look improvements
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder 052047556b doc: add README for the repo
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
David B. Kinder d7938f8ca8 doc: initial doc commit
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-05-11 14:44:27 +08:00
Rraghuveer 981dd9ac88 Initial commit 2018-05-11 14:44:27 +08:00