From b98c5d10fdc895348fc106e5440ec2ee7fbb4707 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 26 Apr 2018 09:00:14 -0700 Subject: [PATCH] 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 --- conf.py | 2 +- howtos/index.rst | 27 +++++++++++++++++++ {images => howtos/process}/acrn-doc-fork.png | Bin docbuild.rst => howtos/process/docbuild.rst | 2 +- howtos/tech/placeholder.rst | 6 +++++ index.rst | 2 +- 6 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 howtos/index.rst rename {images => howtos/process}/acrn-doc-fork.png (100%) rename docbuild.rst => howtos/process/docbuild.rst (99%) create mode 100644 howtos/tech/placeholder.rst diff --git a/conf.py b/conf.py index 743563f7c..9708d8e0a 100644 --- a/conf.py +++ b/conf.py @@ -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/"), ) } diff --git a/howtos/index.rst b/howtos/index.rst new file mode 100644 index 000000000..8f3bedc53 --- /dev/null +++ b/howtos/index.rst @@ -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/* diff --git a/images/acrn-doc-fork.png b/howtos/process/acrn-doc-fork.png similarity index 100% rename from images/acrn-doc-fork.png rename to howtos/process/acrn-doc-fork.png diff --git a/docbuild.rst b/howtos/process/docbuild.rst similarity index 99% rename from docbuild.rst rename to howtos/process/docbuild.rst index 0ec23aebc..adf0ebf67 100644 --- a/docbuild.rst +++ b/howtos/process/docbuild.rst @@ -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 diff --git a/howtos/tech/placeholder.rst b/howtos/tech/placeholder.rst new file mode 100644 index 000000000..01ea3aa10 --- /dev/null +++ b/howtos/tech/placeholder.rst @@ -0,0 +1,6 @@ +.. _wip: + +Work in Progress +################ + +This is a placeholder doc for technical how-to articles in-progress. diff --git a/index.rst b/index.rst index 7760e34e6..a79d9f233 100644 --- a/index.rst +++ b/index.rst @@ -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 ******************