doc: introduce howto area for technical notes

Tech note articles about technology and process tips now have a place in
the ACRN documentaion.

Move the doc process documention into this new area, and add a
placeholder for tech tips for now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-04-26 09:00:14 -07:00 committed by Jack Ren
parent e0a45e8c0f
commit e35874cae1
6 changed files with 36 additions and 3 deletions

View File

@ -161,7 +161,7 @@ else:
html_context = {
'current_version': current_version,
'versions': ( ("latest", "/latest/"),
("0.1-rc4", "/0.1-rc4/"),
# ("0.1-rc4", "/0.1-rc4/"),
)
}

27
doc/howtos/index.rst Normal file
View File

@ -0,0 +1,27 @@
.. _howtos:
How-Tos
#######
Our technical documentation for Project ACRN is being developed right
along with the features. Here are some how-to technical notes that help
explain how you can use ACRN capabilities.
Technical Notes
===============
.. toctree::
:maxdepth: 1
:glob:
tech/*
Process Notes
=============
.. toctree::
:maxdepth: 1
:glob:
process/*

View File

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 54 KiB

View File

@ -73,7 +73,7 @@ upstream project ACRN repos (though https clones work too):
time, visit the **acrn-documentation**, **acrn-hypervisor**, and
**acrn-devicemodel** repos and do a fork to your personal GitHub account.
.. image:: images/acrn-doc-fork.png
.. image:: acrn-doc-fork.png
:align: center
#. At a command prompt, create the working folder and clone the three

View File

@ -0,0 +1,6 @@
.. _wip:
Work in Progress
################
This is a placeholder doc for technical how-to articles in-progress.

View File

@ -28,10 +28,10 @@ Sections
hardware.rst
getting_started/index.rst
primer/index.rst
howtos/index.rst
release_notes.rst
contribute.rst
api/index.rst
docbuild.rst
Indices and Tables
******************