From fd2e4391eacef7f30412f53415e729945f92c0b1 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 1 Aug 2019 21:12:59 -0700 Subject: [PATCH] doc: additional doc navigation restructuring Adjust doc navigation organization based on additional feedback. Signed-off-by: David B. Kinder --- doc/conf.py | 2 +- doc/contribute.rst | 21 +++++++++++++---- doc/develop.rst | 48 +++++++++++++++++--------------------- doc/reference/index.rst | 6 +++-- doc/static/acrn-custom.css | 1 + doc/try.rst | 3 +++ doc/tutorials/skl-nuc.rst | 8 +++---- doc/user-guides/tools.rst | 10 -------- 8 files changed, 52 insertions(+), 47 deletions(-) delete mode 100644 doc/user-guides/tools.rst diff --git a/doc/conf.py b/doc/conf.py index 084275262..a752586f8 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -132,7 +132,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build' ] +exclude_patterns = ['_build', 'misc/README.rst' ] # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/doc/contribute.rst b/doc/contribute.rst index be9fb3b85..cf24d3dbb 100644 --- a/doc/contribute.rst +++ b/doc/contribute.rst @@ -8,8 +8,8 @@ design principles, along with guidelines followed by the development team. With this information, you too can contribute to the project and submit code and documentation patches of your own. -Design Documents -**************** +Design Guides +************* Read about ACRN's high-level design and architecture principles that led to the develoment of the ACRN hypervisor and its components. You'll @@ -27,8 +27,8 @@ also find details about specific architecture topics. developer-guides/VBSK-analysis -Contributing Documents -********************** +Contributing Guides +******************* As an open-source project, we welcome and encourage the community to submit patches for code, documentation, tests, and more, directly to the @@ -44,3 +44,16 @@ the project. developer-guides/doc_guidelines developer-guides/graphviz tutorials/docbuild + +.. _tools: + +Tools +***** + +.. toctree:: + :glob: + :maxdepth: 1 + + misc/tools/acrn-crashlog/README + misc/tools/** + misc/acrn-manager/** diff --git a/doc/develop.rst b/doc/develop.rst index 873b729e8..fda2d1f0b 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -3,61 +3,57 @@ Develop using ACRN ################## + +Configuration Tools +******************* + +- Offline configuration Tool (under developmemnt) + +Configuration Tutorials +*********************** + .. toctree:: :maxdepth: 1 - user-guides/acrn-shell - user-guides/kernel-parameters - user-guides/acrn-dm-parameters - user-guides/tools + tutorials/increase-uos-disk-size + tutorials/sign_clear_linux_image + tutorials/static-ip + tutorials/debug -Selecting OS as a User VM -************************* +User VM Tutorials +***************** .. toctree:: :maxdepth: 1 tutorials/using_agl_as_uos + tutorials/agl-vms tutorials/using_celadon_as_uos tutorials/building_uos_from_clearlinux - tutorials/using_ubuntu_as_sos tutorials/using_vxworks_as_uos tutorials/using_windows_as_uos + tutorials/rt_linux + tutorials/using_zephyr_as_uos -Real time OS setup as User VM -***************************** +Service VM Tutorials +******************** .. toctree:: :maxdepth: 1 - tutorials/rt_linux - tutorials/using_zephyr_as_uos + tutorials/using_ubuntu_as_sos -Tuning and debugging +Enable ACRN Features ******************** .. toctree:: :maxdepth: 1 tutorials/acrn-dm_QoS - tutorials/debug - tutorials/increase-uos-disk-size tutorials/open_vswitch tutorials/rtvm_workload_design_guideline tutorials/sgx_virtualization - tutorials/sign_clear_linux_image tutorials/skl-nuc - tutorials/static-ip tutorials/using_cat_on_up2 - tutorials/using_partition_mode_on_nuc - tutorials/using_partition_mode_on_up2 tutorials/using_sbl_on_up2 - -Other topics -************ - -.. toctree:: - :maxdepth: 1 - - tutorials/agl-vms tutorials/trustyACRN diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 164b20b84..656433e0a 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -6,9 +6,11 @@ Developer references .. toctree:: :maxdepth: 1 - hardware ../api/index - ../reference/kconfig/index + kconfig/index + ../user-guides/acrn-shell + ../user-guides/kernel-parameters + ../user-guides/acrn-dm-parameters * :ref:`glossary` * :ref:`genindex` diff --git a/doc/static/acrn-custom.css b/doc/static/acrn-custom.css index 500a2696f..e32c804b2 100644 --- a/doc/static/acrn-custom.css +++ b/doc/static/acrn-custom.css @@ -223,6 +223,7 @@ kbd align-items: center; border: 1px solid #c6cbce; background-color: #2B978F; + border-radius: 30px; color: white; } diff --git a/doc/try.rst b/doc/try.rst index fc8b3d069..9f8856a75 100644 --- a/doc/try.rst +++ b/doc/try.rst @@ -19,6 +19,9 @@ Follow these getting started guides to give ACRN a try: .. toctree:: :maxdepth: 1 + reference/hardware getting-started/apl-nuc getting-started/up2 getting-started/building-from-source + tutorials/using_partition_mode_on_nuc + tutorials/using_partition_mode_on_up2 diff --git a/doc/tutorials/skl-nuc.rst b/doc/tutorials/skl-nuc.rst index 8ce3c63b8..2b2398637 100644 --- a/doc/tutorials/skl-nuc.rst +++ b/doc/tutorials/skl-nuc.rst @@ -3,10 +3,10 @@ GPU Passthrough on Skylake NUC ############################## -.. warning:: - This community reference release for the Skylake NUC with GPU - passthrough is a one-time snapshot release and is not supported - or maintained. + +This community reference release for the Skylake NUC with GPU +passthrough is a one-time snapshot release and is not supported +or maintained. Hardware platform ***************** diff --git a/doc/user-guides/tools.rst b/doc/user-guides/tools.rst deleted file mode 100644 index 8a3d76687..000000000 --- a/doc/user-guides/tools.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _tools: - -Tools -##### - -.. toctree:: - :glob: - :maxdepth: 1 - - ../misc/**