doc: simplify navigation with restored doc org

dbkinder · wenlingz · commit 34f9fec44cf7 · 2019-08-15T09:57:32.000+08:00
A few more tweaks to the site navigation since we moved the content back
to its original folder structure.

Remove the temporary "doc reorg in progress" banner.

Add reference to hardware in the "try" section.

Add link to the documentation home page in left nav pane.

Add additional redirects to handle external links to moved content.

Signed-off-by: David B. Kinder &lt;david.b.kinder@intel.com&gt;
diff --git a/doc/conf.py b/doc/conf.py
@@ -311,8 +311,9 @@ def setup(app):
 # URLs must be relative to document root (with NO leading slash),
 # and without the html extension)
 html_redirect_pages = [
-   ('developer-guides/index', 'contribute/index'),
-   ('getting-started/index', 'try/index'),
-   ('user-guides/index', 'develop/index'),
+   ('developer-guides/index', 'contribute'),
+   ('getting-started/index', 'try'),
+   ('user-guides/index', 'develop'),
+   ('hardware', 'reference/hardware'),
    ('release_notes', 'release_notes/index')
    ]
diff --git a/doc/contribute.rst b/doc/contribute.rst
@@ -18,13 +18,13 @@ also find details about specific architecture topics.
 .. toctree::
    :maxdepth: 1
 
-   ../developer-guides/modularity
-   ../developer-guides/hld/index
-   ../developer-guides/sw_design_guidelines
-   ../developer-guides/GVT-g-porting
-   ../developer-guides/trusty
-   ../developer-guides/l1tf
-   ../developer-guides/VBSK-analysis
+   developer-guides/modularity
+   developer-guides/hld/index
+   developer-guides/sw_design_guidelines
+   developer-guides/GVT-g-porting
+   developer-guides/trusty
+   developer-guides/l1tf
+   developer-guides/VBSK-analysis
 
 
 Contributing Documents
@@ -39,8 +39,8 @@ the project.
 .. toctree::
    :maxdepth: 1
 
-   ../developer-guides/contribute_guidelines
-   ../developer-guides/coding_guidelines
-   ../developer-guides/doc_guidelines
-   ../developer-guides/graphviz
-   ../tutorials/docbuild.rst
+   developer-guides/contribute_guidelines
+   developer-guides/coding_guidelines
+   developer-guides/doc_guidelines
+   developer-guides/graphviz
+   tutorials/docbuild
diff --git a/doc/develop.rst b/doc/develop.rst
@@ -0,0 +1,63 @@
+.. _develop_acrn:
+
+Develop using ACRN
+##################
+
+.. toctree::
+   :maxdepth: 1
+
+   user-guides/acrn-shell
+   user-guides/kernel-parameters
+   user-guides/acrn-dm-parameters
+   user-guides/tools
+
+Selecting OS as a User VM
+*************************
+
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/using_agl_as_uos
+   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
+
+Real time OS setup as User VM
+*****************************
+
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/rt_linux
+   tutorials/using_zephyr_as_uos
+
+Tuning and debugging
+********************
+
+.. 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/develop/index.rst b/doc/develop/index.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -73,10 +73,11 @@ license.
    :maxdepth: 1
    :hidden:
 
-   learn/index
-   try/index
-   develop/index
-   contribute/index
+   Documentation Home <self>
+   learn
+   try
+   develop
+   contribute
    reference/index
    release_notes/index
    faq
diff --git a/doc/learn.rst b/doc/learn.rst
@@ -0,0 +1,13 @@
+.. _learn_acrn:
+
+Learn about ACRN
+################
+
+ACRN is supported on Apollo Lake and Kaby Lake Intel platforms,
+as described in :ref:`hardware`.
+
+.. toctree::
+   :maxdepth: 1
+
+   introduction/index
+
diff --git a/doc/learn/index.rst b/doc/learn/index.rst
diff --git a/doc/static/acrn-custom.css b/doc/static/acrn-custom.css
@@ -5,14 +5,14 @@
    max-width: none;
 }
 
-/* (temporarily) add an under development tagline to the bread crumb */
+/* (temporarily) add an under development tagline to the bread crumb
 .wy-breadcrumbs::after {
    content: " (Content reorganization in progress)";
    background-color: #FFFACD;
    color: red;
    font-weight: bold;
 }
-/* */
+*/
 
 /* pygments tweak for white-on-black console */
 
diff --git a/doc/try.rst b/doc/try.rst
@@ -11,12 +11,14 @@ hypervisor and the `Clear Linux`_ Service OS and Guest OS on the Intel
 
 .. _Clear Linux: https://clearlinux.org
 
-ACRN development is currently supported on Apollo Lake Intel platforms,
-described in :ref:`hardware`. Follow the setup guides listed here:
+ACRN is supported on Apollo Lake and Kaby Lake Intel platforms,
+as described in :ref:`hardware`.
+
+Follow these getting started guides to give ACRN a try:
 
 .. toctree::
    :maxdepth: 1
 
-   ../getting-started/apl-nuc.rst
-   ../getting-started/up2.rst
-   ../getting-started/building-from-source.rst
+   getting-started/apl-nuc
+   getting-started/up2
+   getting-started/building-from-source

Original file line number	Diff line number	Diff line change
`@@ -5,14 +5,14 @@`
`5`	`5`	`max-width: none;`
`6`	`6`	`}`
`7`	`7`
`8`		`-/* (temporarily) add an under development tagline to the bread crumb */`
	`8`	`+/* (temporarily) add an under development tagline to the bread crumb`
`9`	`9`	`.wy-breadcrumbs::after {`
`10`	`10`	`content: " (Content reorganization in progress)";`
`11`	`11`	`background-color: #FFFACD;`
`12`	`12`	`color: red;`
`13`	`13`	`font-weight: bold;`
`14`	`14`	`}`
`15`		`-/* */`
	`15`	`+*/`
`16`	`16`
`17`	`17`	`/* pygments tweak for white-on-black console */`
`18`	`18`