From b05c8fe1a69fd4ca99ecc3b381c33dda7b44379e Mon Sep 17 00:00:00 2001 From: Andrew Cooper Date: Tue, 26 Mar 2019 11:54:32 +0000 Subject: [PATCH] docs/sphinx: Introduce a hypervisor guide section Include (and retrofit to the user guide) an introductory paragraph describing the intended audience. Signed-off-by: Andrew Cooper Acked-by: Wei Liu --- docs/hypervisor-guide/index.rst | 5 +++++ docs/index.rst | 18 ++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 docs/hypervisor-guide/index.rst diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst new file mode 100644 index 0000000000..3e0cada37d --- /dev/null +++ b/docs/hypervisor-guide/index.rst @@ -0,0 +1,5 @@ +Hypervisor documentation +======================== + +.. toctree:: + :maxdepth: 2 diff --git a/docs/index.rst b/docs/index.rst index 50c40c8174..9e2e256a5d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,25 @@ The Xen Hypervisor documentation User documentation ------------------ +This is documentation for an administrator of a Xen system. It is intended +for someone who is not necesserily a developer, has installed Xen from their +preferred distribution, and is attempting to run virtual machines and +configure the system. + .. toctree:: :maxdepth: 2 admin-guide/index + + +Hypervisor developer documentation +---------------------------------- + +This is documentation for a hypervisor developer. It is intended for someone +who is building Xen from source, and is running the new hypervisor in some +kind of development environment. + +.. toctree:: + :maxdepth: 2 + + hypervisor-guide/index -- 2.30.2