Skip to content

Commit e35874c

Browse files
dbkinderjren1
authored andcommitted
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>
1 parent e0a45e8 commit e35874c

File tree

6 files changed

+36
-3
lines changed

6 files changed

+36
-3
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@
161161
html_context = {
162162
'current_version': current_version,
163163
'versions': ( ("latest", "/latest/"),
164-
("0.1-rc4", "/0.1-rc4/"),
164+
# ("0.1-rc4", "/0.1-rc4/"),
165165
)
166166
}
167167

doc/howtos/index.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.. _howtos:
2+
3+
How-Tos
4+
#######
5+
6+
Our technical documentation for Project ACRN is being developed right
7+
along with the features. Here are some how-to technical notes that help
8+
explain how you can use ACRN capabilities.
9+
10+
11+
Technical Notes
12+
===============
13+
14+
.. toctree::
15+
:maxdepth: 1
16+
:glob:
17+
18+
tech/*
19+
20+
Process Notes
21+
=============
22+
23+
.. toctree::
24+
:maxdepth: 1
25+
:glob:
26+
27+
process/*
File renamed without changes.

doc/docbuild.rst renamed to doc/howtos/process/docbuild.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ upstream project ACRN repos (though https clones work too):
7373
time, visit the **acrn-documentation**, **acrn-hypervisor**, and
7474
**acrn-devicemodel** repos and do a fork to your personal GitHub account.
7575

76-
.. image:: images/acrn-doc-fork.png
76+
.. image:: acrn-doc-fork.png
7777
:align: center
7878

7979
#. At a command prompt, create the working folder and clone the three

doc/howtos/tech/placeholder.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. _wip:
2+
3+
Work in Progress
4+
################
5+
6+
This is a placeholder doc for technical how-to articles in-progress.

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Sections
2828
hardware.rst
2929
getting_started/index.rst
3030
primer/index.rst
31+
howtos/index.rst
3132
release_notes.rst
3233
contribute.rst
3334
api/index.rst
34-
docbuild.rst
3535

3636
Indices and Tables
3737
******************

0 commit comments

Comments
 (0)