diff --git a/doc/.known-issues/doc/redirect.conf b/doc/.known-issues/doc/redirect.conf new file mode 100644 index 000000000..540b576f7 --- /dev/null +++ b/doc/.known-issues/doc/redirect.conf @@ -0,0 +1,4 @@ +# +# Redirect messages +# +^Creating redirect:.* diff --git a/doc/conf.py b/doc/conf.py index d21a1e40a..19a51c315 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -36,7 +36,7 @@ if "RELEASE" in os.environ: sys.path.insert(0, os.path.join(os.path.abspath('.'), 'extensions')) extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinx.ext.extlinks', - 'kerneldoc', 'eager_only'] + 'kerneldoc', 'eager_only', 'html_redirects'] # extlinks provides a macro template @@ -301,3 +301,18 @@ breathe_projects = { } breathe_default_project = "Project ACRN" breathe_default_members = ('members', 'undoc-members', 'content-only') + + +# Custom added feature to allow redirecting old URLs (caused by +# reorganizing doc directories) +# +# list of tuples (old_url, new_url) for pages to redirect +# +# 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'), + ('release_notes', 'release_notes/index') + ] diff --git a/doc/contribute/images/ACRN-favicon-32x32.png b/doc/contribute/images/ACRN-favicon-32x32.png deleted file mode 100644 index eb4798442..000000000 Binary files a/doc/contribute/images/ACRN-favicon-32x32.png and /dev/null differ diff --git a/doc/contribute/images/ACRN_Logo_200w.png b/doc/contribute/images/ACRN_Logo_200w.png deleted file mode 100644 index 16ed1d565..000000000 Binary files a/doc/contribute/images/ACRN_Logo_200w.png and /dev/null differ diff --git a/doc/contribute/images/ACRN_Logo_300w.png b/doc/contribute/images/ACRN_Logo_300w.png deleted file mode 100644 index c26a69b6d..000000000 Binary files a/doc/contribute/images/ACRN_Logo_300w.png and /dev/null differ diff --git a/doc/contribute/images/ACRN_Logo_56h.png b/doc/contribute/images/ACRN_Logo_56h.png deleted file mode 100644 index df74c0efc..000000000 Binary files a/doc/contribute/images/ACRN_Logo_56h.png and /dev/null differ diff --git a/doc/contribute/images/ACRNlogo.png b/doc/contribute/images/ACRNlogo.png deleted file mode 100644 index fa9a41959..000000000 Binary files a/doc/contribute/images/ACRNlogo.png and /dev/null differ diff --git a/doc/contribute/index.rst b/doc/contribute/index.rst index a700a56da..684eef486 100644 --- a/doc/contribute/index.rst +++ b/doc/contribute/index.rst @@ -18,13 +18,13 @@ also find details about specific architecture topics. .. toctree:: :maxdepth: 1 - modularity - hld/index - sw_design_guidelines - GVT-g-porting - trusty - l1tf - 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 - contribute_guidelines - coding_guidelines - doc_guidelines - graphviz + ../developer-guides/contribute_guidelines + ../developer-guides/coding_guidelines + ../developer-guides/doc_guidelines + ../developer-guides/graphviz ../tutorials/docbuild.rst diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 861f7ff07..a3471b2fe 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -6,11 +6,10 @@ Develop using ACRN .. toctree:: :maxdepth: 1 - building-from-source.rst - acrn-shell.rst - kernel-parameters.rst - acrn-dm-parameters.rst - tools.rst + ../user-guides/acrn-shell.rst + ../user-guides/kernel-parameters.rst + ../user-guides/acrn-dm-parameters.rst + ../user-guides/tools.rst Selecting OS as a User VM ************************* diff --git a/doc/contribute/GVT-g-porting.rst b/doc/developer-guides/GVT-g-porting.rst similarity index 100% rename from doc/contribute/GVT-g-porting.rst rename to doc/developer-guides/GVT-g-porting.rst diff --git a/doc/contribute/VBSK-analysis.rst b/doc/developer-guides/VBSK-analysis.rst similarity index 100% rename from doc/contribute/VBSK-analysis.rst rename to doc/developer-guides/VBSK-analysis.rst diff --git a/doc/contribute/asm_coding_guidelines.rst b/doc/developer-guides/asm_coding_guidelines.rst similarity index 100% rename from doc/contribute/asm_coding_guidelines.rst rename to doc/developer-guides/asm_coding_guidelines.rst diff --git a/doc/contribute/c_coding_guidelines.rst b/doc/developer-guides/c_coding_guidelines.rst similarity index 100% rename from doc/contribute/c_coding_guidelines.rst rename to doc/developer-guides/c_coding_guidelines.rst diff --git a/doc/contribute/coding_guidelines.rst b/doc/developer-guides/coding_guidelines.rst similarity index 100% rename from doc/contribute/coding_guidelines.rst rename to doc/developer-guides/coding_guidelines.rst diff --git a/doc/contribute/contribute_guidelines.rst b/doc/developer-guides/contribute_guidelines.rst similarity index 100% rename from doc/contribute/contribute_guidelines.rst rename to doc/developer-guides/contribute_guidelines.rst diff --git a/doc/contribute/doc_guidelines.rst b/doc/developer-guides/doc_guidelines.rst similarity index 100% rename from doc/contribute/doc_guidelines.rst rename to doc/developer-guides/doc_guidelines.rst diff --git a/doc/contribute/graphviz.rst b/doc/developer-guides/graphviz.rst similarity index 100% rename from doc/contribute/graphviz.rst rename to doc/developer-guides/graphviz.rst diff --git a/doc/contribute/hld/hld-APL_GVT-g.rst b/doc/developer-guides/hld/hld-APL_GVT-g.rst similarity index 100% rename from doc/contribute/hld/hld-APL_GVT-g.rst rename to doc/developer-guides/hld/hld-APL_GVT-g.rst diff --git a/doc/contribute/hld/hld-devicemodel.rst b/doc/developer-guides/hld/hld-devicemodel.rst similarity index 100% rename from doc/contribute/hld/hld-devicemodel.rst rename to doc/developer-guides/hld/hld-devicemodel.rst diff --git a/doc/contribute/hld/hld-emulated-devices.rst b/doc/developer-guides/hld/hld-emulated-devices.rst similarity index 100% rename from doc/contribute/hld/hld-emulated-devices.rst rename to doc/developer-guides/hld/hld-emulated-devices.rst diff --git a/doc/contribute/hld/hld-hypervisor.rst b/doc/developer-guides/hld/hld-hypervisor.rst similarity index 100% rename from doc/contribute/hld/hld-hypervisor.rst rename to doc/developer-guides/hld/hld-hypervisor.rst diff --git a/doc/contribute/hld/hld-overview.rst b/doc/developer-guides/hld/hld-overview.rst similarity index 100% rename from doc/contribute/hld/hld-overview.rst rename to doc/developer-guides/hld/hld-overview.rst diff --git a/doc/contribute/hld/hld-power-management.rst b/doc/developer-guides/hld/hld-power-management.rst similarity index 100% rename from doc/contribute/hld/hld-power-management.rst rename to doc/developer-guides/hld/hld-power-management.rst diff --git a/doc/contribute/hld/hld-security.rst b/doc/developer-guides/hld/hld-security.rst similarity index 100% rename from doc/contribute/hld/hld-security.rst rename to doc/developer-guides/hld/hld-security.rst diff --git a/doc/contribute/hld/hld-trace-log.rst b/doc/developer-guides/hld/hld-trace-log.rst similarity index 100% rename from doc/contribute/hld/hld-trace-log.rst rename to doc/developer-guides/hld/hld-trace-log.rst diff --git a/doc/contribute/hld/hld-virtio-devices.rst b/doc/developer-guides/hld/hld-virtio-devices.rst similarity index 100% rename from doc/contribute/hld/hld-virtio-devices.rst rename to doc/developer-guides/hld/hld-virtio-devices.rst diff --git a/doc/contribute/hld/hld-vm-management.rst b/doc/developer-guides/hld/hld-vm-management.rst similarity index 100% rename from doc/contribute/hld/hld-vm-management.rst rename to doc/developer-guides/hld/hld-vm-management.rst diff --git a/doc/contribute/hld/hld-vsbl.rst b/doc/developer-guides/hld/hld-vsbl.rst similarity index 100% rename from doc/contribute/hld/hld-vsbl.rst rename to doc/developer-guides/hld/hld-vsbl.rst diff --git a/doc/contribute/hld/hv-config.rst b/doc/developer-guides/hld/hv-config.rst similarity index 100% rename from doc/contribute/hld/hv-config.rst rename to doc/developer-guides/hld/hv-config.rst diff --git a/doc/contribute/hld/hv-console.rst b/doc/developer-guides/hld/hv-console.rst similarity index 100% rename from doc/contribute/hld/hv-console.rst rename to doc/developer-guides/hld/hv-console.rst diff --git a/doc/contribute/hld/hv-cpu-virt.rst b/doc/developer-guides/hld/hv-cpu-virt.rst similarity index 100% rename from doc/contribute/hld/hv-cpu-virt.rst rename to doc/developer-guides/hld/hv-cpu-virt.rst diff --git a/doc/contribute/hld/hv-dev-passthrough.rst b/doc/developer-guides/hld/hv-dev-passthrough.rst similarity index 100% rename from doc/contribute/hld/hv-dev-passthrough.rst rename to doc/developer-guides/hld/hv-dev-passthrough.rst diff --git a/doc/contribute/hld/hv-hypercall.rst b/doc/developer-guides/hld/hv-hypercall.rst similarity index 100% rename from doc/contribute/hld/hv-hypercall.rst rename to doc/developer-guides/hld/hv-hypercall.rst diff --git a/doc/contribute/hld/hv-interrupt.rst b/doc/developer-guides/hld/hv-interrupt.rst similarity index 100% rename from doc/contribute/hld/hv-interrupt.rst rename to doc/developer-guides/hld/hv-interrupt.rst diff --git a/doc/contribute/hld/hv-io-emulation.rst b/doc/developer-guides/hld/hv-io-emulation.rst similarity index 100% rename from doc/contribute/hld/hv-io-emulation.rst rename to doc/developer-guides/hld/hv-io-emulation.rst diff --git a/doc/contribute/hld/hv-ioc-virt.rst b/doc/developer-guides/hld/hv-ioc-virt.rst similarity index 100% rename from doc/contribute/hld/hv-ioc-virt.rst rename to doc/developer-guides/hld/hv-ioc-virt.rst diff --git a/doc/contribute/hld/hv-memmgt.rst b/doc/developer-guides/hld/hv-memmgt.rst similarity index 100% rename from doc/contribute/hld/hv-memmgt.rst rename to doc/developer-guides/hld/hv-memmgt.rst diff --git a/doc/contribute/hld/hv-partitionmode.rst b/doc/developer-guides/hld/hv-partitionmode.rst similarity index 100% rename from doc/contribute/hld/hv-partitionmode.rst rename to doc/developer-guides/hld/hv-partitionmode.rst diff --git a/doc/contribute/hld/hv-pm.rst b/doc/developer-guides/hld/hv-pm.rst similarity index 100% rename from doc/contribute/hld/hv-pm.rst rename to doc/developer-guides/hld/hv-pm.rst diff --git a/doc/contribute/hld/hv-startup.rst b/doc/developer-guides/hld/hv-startup.rst similarity index 100% rename from doc/contribute/hld/hv-startup.rst rename to doc/developer-guides/hld/hv-startup.rst diff --git a/doc/contribute/hld/hv-timer.rst b/doc/developer-guides/hld/hv-timer.rst similarity index 100% rename from doc/contribute/hld/hv-timer.rst rename to doc/developer-guides/hld/hv-timer.rst diff --git a/doc/contribute/hld/hv-virt-interrupt.rst b/doc/developer-guides/hld/hv-virt-interrupt.rst similarity index 100% rename from doc/contribute/hld/hv-virt-interrupt.rst rename to doc/developer-guides/hld/hv-virt-interrupt.rst diff --git a/doc/contribute/hld/hv-vt-d.rst b/doc/developer-guides/hld/hv-vt-d.rst similarity index 100% rename from doc/contribute/hld/hv-vt-d.rst rename to doc/developer-guides/hld/hv-vt-d.rst diff --git a/doc/contribute/hld/images/APL_GVT-g-DM.png b/doc/developer-guides/hld/images/APL_GVT-g-DM.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-DM.png rename to doc/developer-guides/hld/images/APL_GVT-g-DM.png diff --git a/doc/contribute/hld/images/APL_GVT-g-access-patterns.png b/doc/developer-guides/hld/images/APL_GVT-g-access-patterns.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-access-patterns.png rename to doc/developer-guides/hld/images/APL_GVT-g-access-patterns.png diff --git a/doc/contribute/hld/images/APL_GVT-g-api-forwarding.png b/doc/developer-guides/hld/images/APL_GVT-g-api-forwarding.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-api-forwarding.png rename to doc/developer-guides/hld/images/APL_GVT-g-api-forwarding.png diff --git a/doc/contribute/hld/images/APL_GVT-g-arch.png b/doc/developer-guides/hld/images/APL_GVT-g-arch.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-arch.png rename to doc/developer-guides/hld/images/APL_GVT-g-arch.png diff --git a/doc/contribute/hld/images/APL_GVT-g-direct-display.png b/doc/developer-guides/hld/images/APL_GVT-g-direct-display.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-direct-display.png rename to doc/developer-guides/hld/images/APL_GVT-g-direct-display.png diff --git a/doc/contribute/hld/images/APL_GVT-g-display-virt.png b/doc/developer-guides/hld/images/APL_GVT-g-display-virt.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-display-virt.png rename to doc/developer-guides/hld/images/APL_GVT-g-display-virt.png diff --git a/doc/contribute/hld/images/APL_GVT-g-full-pic.png b/doc/developer-guides/hld/images/APL_GVT-g-full-pic.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-full-pic.png rename to doc/developer-guides/hld/images/APL_GVT-g-full-pic.png diff --git a/doc/contribute/hld/images/APL_GVT-g-graphics-arch.png b/doc/developer-guides/hld/images/APL_GVT-g-graphics-arch.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-graphics-arch.png rename to doc/developer-guides/hld/images/APL_GVT-g-graphics-arch.png diff --git a/doc/contribute/hld/images/APL_GVT-g-hyper-dma.png b/doc/developer-guides/hld/images/APL_GVT-g-hyper-dma.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-hyper-dma.png rename to doc/developer-guides/hld/images/APL_GVT-g-hyper-dma.png diff --git a/doc/contribute/hld/images/APL_GVT-g-indirect-display.png b/doc/developer-guides/hld/images/APL_GVT-g-indirect-display.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-indirect-display.png rename to doc/developer-guides/hld/images/APL_GVT-g-indirect-display.png diff --git a/doc/contribute/hld/images/APL_GVT-g-interrupt-virt.png b/doc/developer-guides/hld/images/APL_GVT-g-interrupt-virt.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-interrupt-virt.png rename to doc/developer-guides/hld/images/APL_GVT-g-interrupt-virt.png diff --git a/doc/contribute/hld/images/APL_GVT-g-ive-use-case.png b/doc/developer-guides/hld/images/APL_GVT-g-ive-use-case.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-ive-use-case.png rename to doc/developer-guides/hld/images/APL_GVT-g-ive-use-case.png diff --git a/doc/contribute/hld/images/APL_GVT-g-mediated-pass-through.png b/doc/developer-guides/hld/images/APL_GVT-g-mediated-pass-through.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-mediated-pass-through.png rename to doc/developer-guides/hld/images/APL_GVT-g-mediated-pass-through.png diff --git a/doc/contribute/hld/images/APL_GVT-g-mem-part.png b/doc/developer-guides/hld/images/APL_GVT-g-mem-part.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-mem-part.png rename to doc/developer-guides/hld/images/APL_GVT-g-mem-part.png diff --git a/doc/contribute/hld/images/APL_GVT-g-pass-through.png b/doc/developer-guides/hld/images/APL_GVT-g-pass-through.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-pass-through.png rename to doc/developer-guides/hld/images/APL_GVT-g-pass-through.png diff --git a/doc/contribute/hld/images/APL_GVT-g-per-vm-shadow.png b/doc/developer-guides/hld/images/APL_GVT-g-per-vm-shadow.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-per-vm-shadow.png rename to doc/developer-guides/hld/images/APL_GVT-g-per-vm-shadow.png diff --git a/doc/contribute/hld/images/APL_GVT-g-perf-critical.png b/doc/developer-guides/hld/images/APL_GVT-g-perf-critical.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-perf-critical.png rename to doc/developer-guides/hld/images/APL_GVT-g-perf-critical.png diff --git a/doc/contribute/hld/images/APL_GVT-g-plane-based.png b/doc/developer-guides/hld/images/APL_GVT-g-plane-based.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-plane-based.png rename to doc/developer-guides/hld/images/APL_GVT-g-plane-based.png diff --git a/doc/contribute/hld/images/APL_GVT-g-scheduling-policy.png b/doc/developer-guides/hld/images/APL_GVT-g-scheduling-policy.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-scheduling-policy.png rename to doc/developer-guides/hld/images/APL_GVT-g-scheduling-policy.png diff --git a/doc/contribute/hld/images/APL_GVT-g-scheduling.png b/doc/developer-guides/hld/images/APL_GVT-g-scheduling.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-scheduling.png rename to doc/developer-guides/hld/images/APL_GVT-g-scheduling.png diff --git a/doc/contribute/hld/images/APL_GVT-g-shared-shadow.png b/doc/developer-guides/hld/images/APL_GVT-g-shared-shadow.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-shared-shadow.png rename to doc/developer-guides/hld/images/APL_GVT-g-shared-shadow.png diff --git a/doc/contribute/hld/images/APL_GVT-g-workload.png b/doc/developer-guides/hld/images/APL_GVT-g-workload.png similarity index 100% rename from doc/contribute/hld/images/APL_GVT-g-workload.png rename to doc/developer-guides/hld/images/APL_GVT-g-workload.png diff --git a/doc/contribute/hld/images/config-image103.png b/doc/developer-guides/hld/images/config-image103.png similarity index 100% rename from doc/contribute/hld/images/config-image103.png rename to doc/developer-guides/hld/images/config-image103.png diff --git a/doc/contribute/hld/images/console-image41.png b/doc/developer-guides/hld/images/console-image41.png similarity index 100% rename from doc/contribute/hld/images/console-image41.png rename to doc/developer-guides/hld/images/console-image41.png diff --git a/doc/contribute/hld/images/console-image93.png b/doc/developer-guides/hld/images/console-image93.png similarity index 100% rename from doc/contribute/hld/images/console-image93.png rename to doc/developer-guides/hld/images/console-image93.png diff --git a/doc/contribute/hld/images/dm-image108.png b/doc/developer-guides/hld/images/dm-image108.png similarity index 100% rename from doc/contribute/hld/images/dm-image108.png rename to doc/developer-guides/hld/images/dm-image108.png diff --git a/doc/contribute/hld/images/dm-image26.png b/doc/developer-guides/hld/images/dm-image26.png similarity index 100% rename from doc/contribute/hld/images/dm-image26.png rename to doc/developer-guides/hld/images/dm-image26.png diff --git a/doc/contribute/hld/images/dm-image33.png b/doc/developer-guides/hld/images/dm-image33.png similarity index 100% rename from doc/contribute/hld/images/dm-image33.png rename to doc/developer-guides/hld/images/dm-image33.png diff --git a/doc/contribute/hld/images/dm-image36.png b/doc/developer-guides/hld/images/dm-image36.png similarity index 100% rename from doc/contribute/hld/images/dm-image36.png rename to doc/developer-guides/hld/images/dm-image36.png diff --git a/doc/contribute/hld/images/dm-image43.png b/doc/developer-guides/hld/images/dm-image43.png similarity index 100% rename from doc/contribute/hld/images/dm-image43.png rename to doc/developer-guides/hld/images/dm-image43.png diff --git a/doc/contribute/hld/images/dm-image52.png b/doc/developer-guides/hld/images/dm-image52.png similarity index 100% rename from doc/contribute/hld/images/dm-image52.png rename to doc/developer-guides/hld/images/dm-image52.png diff --git a/doc/contribute/hld/images/dm-image74.png b/doc/developer-guides/hld/images/dm-image74.png similarity index 100% rename from doc/contribute/hld/images/dm-image74.png rename to doc/developer-guides/hld/images/dm-image74.png diff --git a/doc/contribute/hld/images/dm-image75.png b/doc/developer-guides/hld/images/dm-image75.png similarity index 100% rename from doc/contribute/hld/images/dm-image75.png rename to doc/developer-guides/hld/images/dm-image75.png diff --git a/doc/contribute/hld/images/dm-image80.png b/doc/developer-guides/hld/images/dm-image80.png similarity index 100% rename from doc/contribute/hld/images/dm-image80.png rename to doc/developer-guides/hld/images/dm-image80.png diff --git a/doc/contribute/hld/images/dm-image83.png b/doc/developer-guides/hld/images/dm-image83.png similarity index 100% rename from doc/contribute/hld/images/dm-image83.png rename to doc/developer-guides/hld/images/dm-image83.png diff --git a/doc/contribute/hld/images/dm-image94.png b/doc/developer-guides/hld/images/dm-image94.png similarity index 100% rename from doc/contribute/hld/images/dm-image94.png rename to doc/developer-guides/hld/images/dm-image94.png diff --git a/doc/contribute/hld/images/dm-image96.png b/doc/developer-guides/hld/images/dm-image96.png similarity index 100% rename from doc/contribute/hld/images/dm-image96.png rename to doc/developer-guides/hld/images/dm-image96.png diff --git a/doc/contribute/hld/images/dm-image97.png b/doc/developer-guides/hld/images/dm-image97.png similarity index 100% rename from doc/contribute/hld/images/dm-image97.png rename to doc/developer-guides/hld/images/dm-image97.png diff --git a/doc/contribute/hld/images/dm-image99.png b/doc/developer-guides/hld/images/dm-image99.png similarity index 100% rename from doc/contribute/hld/images/dm-image99.png rename to doc/developer-guides/hld/images/dm-image99.png diff --git a/doc/contribute/hld/images/hld-image104.png b/doc/developer-guides/hld/images/hld-image104.png similarity index 100% rename from doc/contribute/hld/images/hld-image104.png rename to doc/developer-guides/hld/images/hld-image104.png diff --git a/doc/contribute/hld/images/hld-image107.png b/doc/developer-guides/hld/images/hld-image107.png similarity index 100% rename from doc/contribute/hld/images/hld-image107.png rename to doc/developer-guides/hld/images/hld-image107.png diff --git a/doc/contribute/hld/images/hld-image17.png b/doc/developer-guides/hld/images/hld-image17.png similarity index 100% rename from doc/contribute/hld/images/hld-image17.png rename to doc/developer-guides/hld/images/hld-image17.png diff --git a/doc/contribute/hld/images/hld-image35.png b/doc/developer-guides/hld/images/hld-image35.png similarity index 100% rename from doc/contribute/hld/images/hld-image35.png rename to doc/developer-guides/hld/images/hld-image35.png diff --git a/doc/contribute/hld/images/hld-image38.png b/doc/developer-guides/hld/images/hld-image38.png similarity index 100% rename from doc/contribute/hld/images/hld-image38.png rename to doc/developer-guides/hld/images/hld-image38.png diff --git a/doc/contribute/hld/images/hld-image47.png b/doc/developer-guides/hld/images/hld-image47.png similarity index 100% rename from doc/contribute/hld/images/hld-image47.png rename to doc/developer-guides/hld/images/hld-image47.png diff --git a/doc/contribute/hld/images/hld-image68.png b/doc/developer-guides/hld/images/hld-image68.png similarity index 100% rename from doc/contribute/hld/images/hld-image68.png rename to doc/developer-guides/hld/images/hld-image68.png diff --git a/doc/contribute/hld/images/hld-image7.png b/doc/developer-guides/hld/images/hld-image7.png similarity index 100% rename from doc/contribute/hld/images/hld-image7.png rename to doc/developer-guides/hld/images/hld-image7.png diff --git a/doc/contribute/hld/images/hld-image82.png b/doc/developer-guides/hld/images/hld-image82.png similarity index 100% rename from doc/contribute/hld/images/hld-image82.png rename to doc/developer-guides/hld/images/hld-image82.png diff --git a/doc/contribute/hld/images/hld-pm-image28.png b/doc/developer-guides/hld/images/hld-pm-image28.png similarity index 100% rename from doc/contribute/hld/images/hld-pm-image28.png rename to doc/developer-guides/hld/images/hld-pm-image28.png diff --git a/doc/contribute/hld/images/hld-pm-image62.png b/doc/developer-guides/hld/images/hld-pm-image62.png similarity index 100% rename from doc/contribute/hld/images/hld-pm-image62.png rename to doc/developer-guides/hld/images/hld-pm-image62.png diff --git a/doc/contribute/hld/images/interrupt-image2.png b/doc/developer-guides/hld/images/interrupt-image2.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image2.png rename to doc/developer-guides/hld/images/interrupt-image2.png diff --git a/doc/contribute/hld/images/interrupt-image3.png b/doc/developer-guides/hld/images/interrupt-image3.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image3.png rename to doc/developer-guides/hld/images/interrupt-image3.png diff --git a/doc/contribute/hld/images/interrupt-image39.png b/doc/developer-guides/hld/images/interrupt-image39.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image39.png rename to doc/developer-guides/hld/images/interrupt-image39.png diff --git a/doc/contribute/hld/images/interrupt-image46.png b/doc/developer-guides/hld/images/interrupt-image46.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image46.png rename to doc/developer-guides/hld/images/interrupt-image46.png diff --git a/doc/contribute/hld/images/interrupt-image48.png b/doc/developer-guides/hld/images/interrupt-image48.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image48.png rename to doc/developer-guides/hld/images/interrupt-image48.png diff --git a/doc/contribute/hld/images/interrupt-image66.png b/doc/developer-guides/hld/images/interrupt-image66.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image66.png rename to doc/developer-guides/hld/images/interrupt-image66.png diff --git a/doc/contribute/hld/images/interrupt-image76.png b/doc/developer-guides/hld/images/interrupt-image76.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image76.png rename to doc/developer-guides/hld/images/interrupt-image76.png diff --git a/doc/contribute/hld/images/interrupt-image89.png b/doc/developer-guides/hld/images/interrupt-image89.png similarity index 100% rename from doc/contribute/hld/images/interrupt-image89.png rename to doc/developer-guides/hld/images/interrupt-image89.png diff --git a/doc/contribute/hld/images/ioc-image1.png b/doc/developer-guides/hld/images/ioc-image1.png similarity index 100% rename from doc/contribute/hld/images/ioc-image1.png rename to doc/developer-guides/hld/images/ioc-image1.png diff --git a/doc/contribute/hld/images/ioc-image10.png b/doc/developer-guides/hld/images/ioc-image10.png similarity index 100% rename from doc/contribute/hld/images/ioc-image10.png rename to doc/developer-guides/hld/images/ioc-image10.png diff --git a/doc/contribute/hld/images/ioc-image12.png b/doc/developer-guides/hld/images/ioc-image12.png similarity index 100% rename from doc/contribute/hld/images/ioc-image12.png rename to doc/developer-guides/hld/images/ioc-image12.png diff --git a/doc/contribute/hld/images/ioc-image13.png b/doc/developer-guides/hld/images/ioc-image13.png similarity index 100% rename from doc/contribute/hld/images/ioc-image13.png rename to doc/developer-guides/hld/images/ioc-image13.png diff --git a/doc/contribute/hld/images/ioc-image14.png b/doc/developer-guides/hld/images/ioc-image14.png similarity index 100% rename from doc/contribute/hld/images/ioc-image14.png rename to doc/developer-guides/hld/images/ioc-image14.png diff --git a/doc/contribute/hld/images/ioc-image15.png b/doc/developer-guides/hld/images/ioc-image15.png similarity index 100% rename from doc/contribute/hld/images/ioc-image15.png rename to doc/developer-guides/hld/images/ioc-image15.png diff --git a/doc/contribute/hld/images/ioc-image16.png b/doc/developer-guides/hld/images/ioc-image16.png similarity index 100% rename from doc/contribute/hld/images/ioc-image16.png rename to doc/developer-guides/hld/images/ioc-image16.png diff --git a/doc/contribute/hld/images/ioc-image17.png b/doc/developer-guides/hld/images/ioc-image17.png similarity index 100% rename from doc/contribute/hld/images/ioc-image17.png rename to doc/developer-guides/hld/images/ioc-image17.png diff --git a/doc/contribute/hld/images/ioc-image18.png b/doc/developer-guides/hld/images/ioc-image18.png similarity index 100% rename from doc/contribute/hld/images/ioc-image18.png rename to doc/developer-guides/hld/images/ioc-image18.png diff --git a/doc/contribute/hld/images/ioc-image19.png b/doc/developer-guides/hld/images/ioc-image19.png similarity index 100% rename from doc/contribute/hld/images/ioc-image19.png rename to doc/developer-guides/hld/images/ioc-image19.png diff --git a/doc/contribute/hld/images/ioc-image2.png b/doc/developer-guides/hld/images/ioc-image2.png similarity index 100% rename from doc/contribute/hld/images/ioc-image2.png rename to doc/developer-guides/hld/images/ioc-image2.png diff --git a/doc/contribute/hld/images/ioc-image20.png b/doc/developer-guides/hld/images/ioc-image20.png similarity index 100% rename from doc/contribute/hld/images/ioc-image20.png rename to doc/developer-guides/hld/images/ioc-image20.png diff --git a/doc/contribute/hld/images/ioc-image21.png b/doc/developer-guides/hld/images/ioc-image21.png similarity index 100% rename from doc/contribute/hld/images/ioc-image21.png rename to doc/developer-guides/hld/images/ioc-image21.png diff --git a/doc/contribute/hld/images/ioc-image22.png b/doc/developer-guides/hld/images/ioc-image22.png similarity index 100% rename from doc/contribute/hld/images/ioc-image22.png rename to doc/developer-guides/hld/images/ioc-image22.png diff --git a/doc/contribute/hld/images/ioc-image24.png b/doc/developer-guides/hld/images/ioc-image24.png similarity index 100% rename from doc/contribute/hld/images/ioc-image24.png rename to doc/developer-guides/hld/images/ioc-image24.png diff --git a/doc/contribute/hld/images/ioc-image3.png b/doc/developer-guides/hld/images/ioc-image3.png similarity index 100% rename from doc/contribute/hld/images/ioc-image3.png rename to doc/developer-guides/hld/images/ioc-image3.png diff --git a/doc/contribute/hld/images/ioc-image4.png b/doc/developer-guides/hld/images/ioc-image4.png similarity index 100% rename from doc/contribute/hld/images/ioc-image4.png rename to doc/developer-guides/hld/images/ioc-image4.png diff --git a/doc/contribute/hld/images/ioc-image49.png b/doc/developer-guides/hld/images/ioc-image49.png similarity index 100% rename from doc/contribute/hld/images/ioc-image49.png rename to doc/developer-guides/hld/images/ioc-image49.png diff --git a/doc/contribute/hld/images/ioc-image5.png b/doc/developer-guides/hld/images/ioc-image5.png similarity index 100% rename from doc/contribute/hld/images/ioc-image5.png rename to doc/developer-guides/hld/images/ioc-image5.png diff --git a/doc/contribute/hld/images/ioc-image6.png b/doc/developer-guides/hld/images/ioc-image6.png similarity index 100% rename from doc/contribute/hld/images/ioc-image6.png rename to doc/developer-guides/hld/images/ioc-image6.png diff --git a/doc/contribute/hld/images/ioc-image65.png b/doc/developer-guides/hld/images/ioc-image65.png similarity index 100% rename from doc/contribute/hld/images/ioc-image65.png rename to doc/developer-guides/hld/images/ioc-image65.png diff --git a/doc/contribute/hld/images/ioc-image7.png b/doc/developer-guides/hld/images/ioc-image7.png similarity index 100% rename from doc/contribute/hld/images/ioc-image7.png rename to doc/developer-guides/hld/images/ioc-image7.png diff --git a/doc/contribute/hld/images/ioc-image8.png b/doc/developer-guides/hld/images/ioc-image8.png similarity index 100% rename from doc/contribute/hld/images/ioc-image8.png rename to doc/developer-guides/hld/images/ioc-image8.png diff --git a/doc/contribute/hld/images/ioc-image9.png b/doc/developer-guides/hld/images/ioc-image9.png similarity index 100% rename from doc/contribute/hld/images/ioc-image9.png rename to doc/developer-guides/hld/images/ioc-image9.png diff --git a/doc/contribute/hld/images/ioem-image100.png b/doc/developer-guides/hld/images/ioem-image100.png similarity index 100% rename from doc/contribute/hld/images/ioem-image100.png rename to doc/developer-guides/hld/images/ioem-image100.png diff --git a/doc/contribute/hld/images/ioem-image101.png b/doc/developer-guides/hld/images/ioem-image101.png similarity index 100% rename from doc/contribute/hld/images/ioem-image101.png rename to doc/developer-guides/hld/images/ioem-image101.png diff --git a/doc/contribute/hld/images/ioem-image106.png b/doc/developer-guides/hld/images/ioem-image106.png similarity index 100% rename from doc/contribute/hld/images/ioem-image106.png rename to doc/developer-guides/hld/images/ioem-image106.png diff --git a/doc/contribute/hld/images/ioem-image92.png b/doc/developer-guides/hld/images/ioem-image92.png similarity index 100% rename from doc/contribute/hld/images/ioem-image92.png rename to doc/developer-guides/hld/images/ioem-image92.png diff --git a/doc/contribute/hld/images/log-image50.png b/doc/developer-guides/hld/images/log-image50.png similarity index 100% rename from doc/contribute/hld/images/log-image50.png rename to doc/developer-guides/hld/images/log-image50.png diff --git a/doc/contribute/hld/images/log-image59.png b/doc/developer-guides/hld/images/log-image59.png similarity index 100% rename from doc/contribute/hld/images/log-image59.png rename to doc/developer-guides/hld/images/log-image59.png diff --git a/doc/contribute/hld/images/log-image73.png b/doc/developer-guides/hld/images/log-image73.png similarity index 100% rename from doc/contribute/hld/images/log-image73.png rename to doc/developer-guides/hld/images/log-image73.png diff --git a/doc/contribute/hld/images/mem-image1.png b/doc/developer-guides/hld/images/mem-image1.png similarity index 100% rename from doc/contribute/hld/images/mem-image1.png rename to doc/developer-guides/hld/images/mem-image1.png diff --git a/doc/contribute/hld/images/mem-image18.png b/doc/developer-guides/hld/images/mem-image18.png similarity index 100% rename from doc/contribute/hld/images/mem-image18.png rename to doc/developer-guides/hld/images/mem-image18.png diff --git a/doc/contribute/hld/images/mem-image2.png b/doc/developer-guides/hld/images/mem-image2.png similarity index 100% rename from doc/contribute/hld/images/mem-image2.png rename to doc/developer-guides/hld/images/mem-image2.png diff --git a/doc/contribute/hld/images/mem-image3.png b/doc/developer-guides/hld/images/mem-image3.png similarity index 100% rename from doc/contribute/hld/images/mem-image3.png rename to doc/developer-guides/hld/images/mem-image3.png diff --git a/doc/contribute/hld/images/mem-image45.png b/doc/developer-guides/hld/images/mem-image45.png similarity index 100% rename from doc/contribute/hld/images/mem-image45.png rename to doc/developer-guides/hld/images/mem-image45.png diff --git a/doc/contribute/hld/images/mem-image5.png b/doc/developer-guides/hld/images/mem-image5.png similarity index 100% rename from doc/contribute/hld/images/mem-image5.png rename to doc/developer-guides/hld/images/mem-image5.png diff --git a/doc/contribute/hld/images/mem-image6.png b/doc/developer-guides/hld/images/mem-image6.png similarity index 100% rename from doc/contribute/hld/images/mem-image6.png rename to doc/developer-guides/hld/images/mem-image6.png diff --git a/doc/contribute/hld/images/mem-image69.png b/doc/developer-guides/hld/images/mem-image69.png similarity index 100% rename from doc/contribute/hld/images/mem-image69.png rename to doc/developer-guides/hld/images/mem-image69.png diff --git a/doc/contribute/hld/images/mem-image7.png b/doc/developer-guides/hld/images/mem-image7.png similarity index 100% rename from doc/contribute/hld/images/mem-image7.png rename to doc/developer-guides/hld/images/mem-image7.png diff --git a/doc/contribute/hld/images/mem-image8.png b/doc/developer-guides/hld/images/mem-image8.png similarity index 100% rename from doc/contribute/hld/images/mem-image8.png rename to doc/developer-guides/hld/images/mem-image8.png diff --git a/doc/contribute/hld/images/mem-image84.png b/doc/developer-guides/hld/images/mem-image84.png similarity index 100% rename from doc/contribute/hld/images/mem-image84.png rename to doc/developer-guides/hld/images/mem-image84.png diff --git a/doc/contribute/hld/images/network-virt-arch.png b/doc/developer-guides/hld/images/network-virt-arch.png similarity index 100% rename from doc/contribute/hld/images/network-virt-arch.png rename to doc/developer-guides/hld/images/network-virt-arch.png diff --git a/doc/contribute/hld/images/network-virt-sos-infrastruct.png b/doc/developer-guides/hld/images/network-virt-sos-infrastruct.png similarity index 100% rename from doc/contribute/hld/images/network-virt-sos-infrastruct.png rename to doc/developer-guides/hld/images/network-virt-sos-infrastruct.png diff --git a/doc/contribute/hld/images/over-image11.png b/doc/developer-guides/hld/images/over-image11.png similarity index 100% rename from doc/contribute/hld/images/over-image11.png rename to doc/developer-guides/hld/images/over-image11.png diff --git a/doc/contribute/hld/images/over-image110.png b/doc/developer-guides/hld/images/over-image110.png similarity index 100% rename from doc/contribute/hld/images/over-image110.png rename to doc/developer-guides/hld/images/over-image110.png diff --git a/doc/contribute/hld/images/over-image13.png b/doc/developer-guides/hld/images/over-image13.png similarity index 100% rename from doc/contribute/hld/images/over-image13.png rename to doc/developer-guides/hld/images/over-image13.png diff --git a/doc/contribute/hld/images/over-image15.png b/doc/developer-guides/hld/images/over-image15.png similarity index 100% rename from doc/contribute/hld/images/over-image15.png rename to doc/developer-guides/hld/images/over-image15.png diff --git a/doc/contribute/hld/images/over-image21.png b/doc/developer-guides/hld/images/over-image21.png similarity index 100% rename from doc/contribute/hld/images/over-image21.png rename to doc/developer-guides/hld/images/over-image21.png diff --git a/doc/contribute/hld/images/over-image29.png b/doc/developer-guides/hld/images/over-image29.png similarity index 100% rename from doc/contribute/hld/images/over-image29.png rename to doc/developer-guides/hld/images/over-image29.png diff --git a/doc/contribute/hld/images/over-image34.png b/doc/developer-guides/hld/images/over-image34.png similarity index 100% rename from doc/contribute/hld/images/over-image34.png rename to doc/developer-guides/hld/images/over-image34.png diff --git a/doc/contribute/hld/images/over-image4.png b/doc/developer-guides/hld/images/over-image4.png similarity index 100% rename from doc/contribute/hld/images/over-image4.png rename to doc/developer-guides/hld/images/over-image4.png diff --git a/doc/contribute/hld/images/over-image85.png b/doc/developer-guides/hld/images/over-image85.png similarity index 100% rename from doc/contribute/hld/images/over-image85.png rename to doc/developer-guides/hld/images/over-image85.png diff --git a/doc/contribute/hld/images/partition-image1.png b/doc/developer-guides/hld/images/partition-image1.png similarity index 100% rename from doc/contribute/hld/images/partition-image1.png rename to doc/developer-guides/hld/images/partition-image1.png diff --git a/doc/contribute/hld/images/partition-image13.png b/doc/developer-guides/hld/images/partition-image13.png similarity index 100% rename from doc/contribute/hld/images/partition-image13.png rename to doc/developer-guides/hld/images/partition-image13.png diff --git a/doc/contribute/hld/images/partition-image14.png b/doc/developer-guides/hld/images/partition-image14.png similarity index 100% rename from doc/contribute/hld/images/partition-image14.png rename to doc/developer-guides/hld/images/partition-image14.png diff --git a/doc/contribute/hld/images/partition-image16.png b/doc/developer-guides/hld/images/partition-image16.png similarity index 100% rename from doc/contribute/hld/images/partition-image16.png rename to doc/developer-guides/hld/images/partition-image16.png diff --git a/doc/contribute/hld/images/partition-image18.png b/doc/developer-guides/hld/images/partition-image18.png similarity index 100% rename from doc/contribute/hld/images/partition-image18.png rename to doc/developer-guides/hld/images/partition-image18.png diff --git a/doc/contribute/hld/images/partition-image20.png b/doc/developer-guides/hld/images/partition-image20.png similarity index 100% rename from doc/contribute/hld/images/partition-image20.png rename to doc/developer-guides/hld/images/partition-image20.png diff --git a/doc/contribute/hld/images/partition-image3.png b/doc/developer-guides/hld/images/partition-image3.png similarity index 100% rename from doc/contribute/hld/images/partition-image3.png rename to doc/developer-guides/hld/images/partition-image3.png diff --git a/doc/contribute/hld/images/partition-image7.png b/doc/developer-guides/hld/images/partition-image7.png similarity index 100% rename from doc/contribute/hld/images/partition-image7.png rename to doc/developer-guides/hld/images/partition-image7.png diff --git a/doc/contribute/hld/images/passthru-image102.png b/doc/developer-guides/hld/images/passthru-image102.png similarity index 100% rename from doc/contribute/hld/images/passthru-image102.png rename to doc/developer-guides/hld/images/passthru-image102.png diff --git a/doc/contribute/hld/images/passthru-image22.png b/doc/developer-guides/hld/images/passthru-image22.png similarity index 100% rename from doc/contribute/hld/images/passthru-image22.png rename to doc/developer-guides/hld/images/passthru-image22.png diff --git a/doc/contribute/hld/images/passthru-image30.png b/doc/developer-guides/hld/images/passthru-image30.png similarity index 100% rename from doc/contribute/hld/images/passthru-image30.png rename to doc/developer-guides/hld/images/passthru-image30.png diff --git a/doc/contribute/hld/images/passthru-image42.png b/doc/developer-guides/hld/images/passthru-image42.png similarity index 100% rename from doc/contribute/hld/images/passthru-image42.png rename to doc/developer-guides/hld/images/passthru-image42.png diff --git a/doc/contribute/hld/images/passthru-image72.png b/doc/developer-guides/hld/images/passthru-image72.png similarity index 100% rename from doc/contribute/hld/images/passthru-image72.png rename to doc/developer-guides/hld/images/passthru-image72.png diff --git a/doc/contribute/hld/images/passthru-image77.png b/doc/developer-guides/hld/images/passthru-image77.png similarity index 100% rename from doc/contribute/hld/images/passthru-image77.png rename to doc/developer-guides/hld/images/passthru-image77.png diff --git a/doc/contribute/hld/images/passthru-image86.png b/doc/developer-guides/hld/images/passthru-image86.png similarity index 100% rename from doc/contribute/hld/images/passthru-image86.png rename to doc/developer-guides/hld/images/passthru-image86.png diff --git a/doc/contribute/hld/images/passthru-image91.png b/doc/developer-guides/hld/images/passthru-image91.png similarity index 100% rename from doc/contribute/hld/images/passthru-image91.png rename to doc/developer-guides/hld/images/passthru-image91.png diff --git a/doc/contribute/hld/images/passthru-image98.png b/doc/developer-guides/hld/images/passthru-image98.png similarity index 100% rename from doc/contribute/hld/images/passthru-image98.png rename to doc/developer-guides/hld/images/passthru-image98.png diff --git a/doc/contribute/hld/images/pm-image24-105.png b/doc/developer-guides/hld/images/pm-image24-105.png similarity index 100% rename from doc/contribute/hld/images/pm-image24-105.png rename to doc/developer-guides/hld/images/pm-image24-105.png diff --git a/doc/contribute/hld/images/rand-virt.png b/doc/developer-guides/hld/images/rand-virt.png similarity index 100% rename from doc/contribute/hld/images/rand-virt.png rename to doc/developer-guides/hld/images/rand-virt.png diff --git a/doc/contribute/hld/images/security-image1.png b/doc/developer-guides/hld/images/security-image1.png similarity index 100% rename from doc/contribute/hld/images/security-image1.png rename to doc/developer-guides/hld/images/security-image1.png diff --git a/doc/contribute/hld/images/security-image10.png b/doc/developer-guides/hld/images/security-image10.png similarity index 100% rename from doc/contribute/hld/images/security-image10.png rename to doc/developer-guides/hld/images/security-image10.png diff --git a/doc/contribute/hld/images/security-image11.png b/doc/developer-guides/hld/images/security-image11.png similarity index 100% rename from doc/contribute/hld/images/security-image11.png rename to doc/developer-guides/hld/images/security-image11.png diff --git a/doc/contribute/hld/images/security-image12.png b/doc/developer-guides/hld/images/security-image12.png similarity index 100% rename from doc/contribute/hld/images/security-image12.png rename to doc/developer-guides/hld/images/security-image12.png diff --git a/doc/contribute/hld/images/security-image13.png b/doc/developer-guides/hld/images/security-image13.png similarity index 100% rename from doc/contribute/hld/images/security-image13.png rename to doc/developer-guides/hld/images/security-image13.png diff --git a/doc/contribute/hld/images/security-image14.png b/doc/developer-guides/hld/images/security-image14.png similarity index 100% rename from doc/contribute/hld/images/security-image14.png rename to doc/developer-guides/hld/images/security-image14.png diff --git a/doc/contribute/hld/images/security-image2.png b/doc/developer-guides/hld/images/security-image2.png similarity index 100% rename from doc/contribute/hld/images/security-image2.png rename to doc/developer-guides/hld/images/security-image2.png diff --git a/doc/contribute/hld/images/security-image3.png b/doc/developer-guides/hld/images/security-image3.png similarity index 100% rename from doc/contribute/hld/images/security-image3.png rename to doc/developer-guides/hld/images/security-image3.png diff --git a/doc/contribute/hld/images/security-image4.png b/doc/developer-guides/hld/images/security-image4.png similarity index 100% rename from doc/contribute/hld/images/security-image4.png rename to doc/developer-guides/hld/images/security-image4.png diff --git a/doc/contribute/hld/images/security-image5.png b/doc/developer-guides/hld/images/security-image5.png similarity index 100% rename from doc/contribute/hld/images/security-image5.png rename to doc/developer-guides/hld/images/security-image5.png diff --git a/doc/contribute/hld/images/security-image6.png b/doc/developer-guides/hld/images/security-image6.png similarity index 100% rename from doc/contribute/hld/images/security-image6.png rename to doc/developer-guides/hld/images/security-image6.png diff --git a/doc/contribute/hld/images/security-image7.png b/doc/developer-guides/hld/images/security-image7.png similarity index 100% rename from doc/contribute/hld/images/security-image7.png rename to doc/developer-guides/hld/images/security-image7.png diff --git a/doc/contribute/hld/images/security-image8.png b/doc/developer-guides/hld/images/security-image8.png similarity index 100% rename from doc/contribute/hld/images/security-image8.png rename to doc/developer-guides/hld/images/security-image8.png diff --git a/doc/contribute/hld/images/security-image9.png b/doc/developer-guides/hld/images/security-image9.png similarity index 100% rename from doc/contribute/hld/images/security-image9.png rename to doc/developer-guides/hld/images/security-image9.png diff --git a/doc/contribute/hld/images/static-core-image1.png b/doc/developer-guides/hld/images/static-core-image1.png similarity index 100% rename from doc/contribute/hld/images/static-core-image1.png rename to doc/developer-guides/hld/images/static-core-image1.png diff --git a/doc/contribute/hld/images/static-core-image2.png b/doc/developer-guides/hld/images/static-core-image2.png similarity index 100% rename from doc/contribute/hld/images/static-core-image2.png rename to doc/developer-guides/hld/images/static-core-image2.png diff --git a/doc/contribute/hld/images/uart-image1.png b/doc/developer-guides/hld/images/uart-image1.png similarity index 100% rename from doc/contribute/hld/images/uart-image1.png rename to doc/developer-guides/hld/images/uart-image1.png diff --git a/doc/contribute/hld/images/usb-image10.png b/doc/developer-guides/hld/images/usb-image10.png similarity index 100% rename from doc/contribute/hld/images/usb-image10.png rename to doc/developer-guides/hld/images/usb-image10.png diff --git a/doc/contribute/hld/images/usb-image31.png b/doc/developer-guides/hld/images/usb-image31.png similarity index 100% rename from doc/contribute/hld/images/usb-image31.png rename to doc/developer-guides/hld/images/usb-image31.png diff --git a/doc/contribute/hld/images/usb-image51.png b/doc/developer-guides/hld/images/usb-image51.png similarity index 100% rename from doc/contribute/hld/images/usb-image51.png rename to doc/developer-guides/hld/images/usb-image51.png diff --git a/doc/contribute/hld/images/virtint-image64.png b/doc/developer-guides/hld/images/virtint-image64.png similarity index 100% rename from doc/contribute/hld/images/virtint-image64.png rename to doc/developer-guides/hld/images/virtint-image64.png diff --git a/doc/contribute/hld/images/virtio-blk-image01.png b/doc/developer-guides/hld/images/virtio-blk-image01.png similarity index 100% rename from doc/contribute/hld/images/virtio-blk-image01.png rename to doc/developer-guides/hld/images/virtio-blk-image01.png diff --git a/doc/contribute/hld/images/virtio-blk-image02.png b/doc/developer-guides/hld/images/virtio-blk-image02.png similarity index 100% rename from doc/contribute/hld/images/virtio-blk-image02.png rename to doc/developer-guides/hld/images/virtio-blk-image02.png diff --git a/doc/contribute/hld/images/virtio-console-arch.png b/doc/developer-guides/hld/images/virtio-console-arch.png similarity index 100% rename from doc/contribute/hld/images/virtio-console-arch.png rename to doc/developer-guides/hld/images/virtio-console-arch.png diff --git a/doc/contribute/hld/images/virtio-hld-image0.png b/doc/developer-guides/hld/images/virtio-hld-image0.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image0.png rename to doc/developer-guides/hld/images/virtio-hld-image0.png diff --git a/doc/contribute/hld/images/virtio-hld-image1.png b/doc/developer-guides/hld/images/virtio-hld-image1.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image1.png rename to doc/developer-guides/hld/images/virtio-hld-image1.png diff --git a/doc/contribute/hld/images/virtio-hld-image2.png b/doc/developer-guides/hld/images/virtio-hld-image2.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image2.png rename to doc/developer-guides/hld/images/virtio-hld-image2.png diff --git a/doc/contribute/hld/images/virtio-hld-image3.png b/doc/developer-guides/hld/images/virtio-hld-image3.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image3.png rename to doc/developer-guides/hld/images/virtio-hld-image3.png diff --git a/doc/contribute/hld/images/virtio-hld-image4.png b/doc/developer-guides/hld/images/virtio-hld-image4.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image4.png rename to doc/developer-guides/hld/images/virtio-hld-image4.png diff --git a/doc/contribute/hld/images/virtio-hld-image5.png b/doc/developer-guides/hld/images/virtio-hld-image5.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image5.png rename to doc/developer-guides/hld/images/virtio-hld-image5.png diff --git a/doc/contribute/hld/images/virtio-hld-image53.png b/doc/developer-guides/hld/images/virtio-hld-image53.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image53.png rename to doc/developer-guides/hld/images/virtio-hld-image53.png diff --git a/doc/contribute/hld/images/virtio-hld-image54.png b/doc/developer-guides/hld/images/virtio-hld-image54.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image54.png rename to doc/developer-guides/hld/images/virtio-hld-image54.png diff --git a/doc/contribute/hld/images/virtio-hld-image58.png b/doc/developer-guides/hld/images/virtio-hld-image58.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image58.png rename to doc/developer-guides/hld/images/virtio-hld-image58.png diff --git a/doc/contribute/hld/images/virtio-hld-image6.png b/doc/developer-guides/hld/images/virtio-hld-image6.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image6.png rename to doc/developer-guides/hld/images/virtio-hld-image6.png diff --git a/doc/contribute/hld/images/virtio-hld-image60.png b/doc/developer-guides/hld/images/virtio-hld-image60.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image60.png rename to doc/developer-guides/hld/images/virtio-hld-image60.png diff --git a/doc/contribute/hld/images/virtio-hld-image61.png b/doc/developer-guides/hld/images/virtio-hld-image61.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image61.png rename to doc/developer-guides/hld/images/virtio-hld-image61.png diff --git a/doc/contribute/hld/images/virtio-hld-image7.png b/doc/developer-guides/hld/images/virtio-hld-image7.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image7.png rename to doc/developer-guides/hld/images/virtio-hld-image7.png diff --git a/doc/contribute/hld/images/virtio-hld-image71.png b/doc/developer-guides/hld/images/virtio-hld-image71.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image71.png rename to doc/developer-guides/hld/images/virtio-hld-image71.png diff --git a/doc/contribute/hld/images/virtio-hld-image8.png b/doc/developer-guides/hld/images/virtio-hld-image8.png similarity index 100% rename from doc/contribute/hld/images/virtio-hld-image8.png rename to doc/developer-guides/hld/images/virtio-hld-image8.png diff --git a/doc/contribute/hld/images/vt-d-image19.png b/doc/developer-guides/hld/images/vt-d-image19.png similarity index 100% rename from doc/contribute/hld/images/vt-d-image19.png rename to doc/developer-guides/hld/images/vt-d-image19.png diff --git a/doc/contribute/hld/images/vt-d-image40.png b/doc/developer-guides/hld/images/vt-d-image40.png similarity index 100% rename from doc/contribute/hld/images/vt-d-image40.png rename to doc/developer-guides/hld/images/vt-d-image40.png diff --git a/doc/contribute/hld/images/vt-d-image44.png b/doc/developer-guides/hld/images/vt-d-image44.png similarity index 100% rename from doc/contribute/hld/images/vt-d-image44.png rename to doc/developer-guides/hld/images/vt-d-image44.png diff --git a/doc/contribute/hld/images/vt-d-image90.png b/doc/developer-guides/hld/images/vt-d-image90.png similarity index 100% rename from doc/contribute/hld/images/vt-d-image90.png rename to doc/developer-guides/hld/images/vt-d-image90.png diff --git a/doc/contribute/hld/images/watchdog-image1.png b/doc/developer-guides/hld/images/watchdog-image1.png similarity index 100% rename from doc/contribute/hld/images/watchdog-image1.png rename to doc/developer-guides/hld/images/watchdog-image1.png diff --git a/doc/contribute/hld/images/watchdog-image2.png b/doc/developer-guides/hld/images/watchdog-image2.png similarity index 100% rename from doc/contribute/hld/images/watchdog-image2.png rename to doc/developer-guides/hld/images/watchdog-image2.png diff --git a/doc/contribute/hld/index.rst b/doc/developer-guides/hld/index.rst similarity index 100% rename from doc/contribute/hld/index.rst rename to doc/developer-guides/hld/index.rst diff --git a/doc/contribute/hld/random-virt-hld.rst b/doc/developer-guides/hld/random-virt-hld.rst similarity index 100% rename from doc/contribute/hld/random-virt-hld.rst rename to doc/developer-guides/hld/random-virt-hld.rst diff --git a/doc/contribute/hld/uart-virt-hld.rst b/doc/developer-guides/hld/uart-virt-hld.rst similarity index 100% rename from doc/contribute/hld/uart-virt-hld.rst rename to doc/developer-guides/hld/uart-virt-hld.rst diff --git a/doc/contribute/hld/usb-virt-hld.rst b/doc/developer-guides/hld/usb-virt-hld.rst similarity index 100% rename from doc/contribute/hld/usb-virt-hld.rst rename to doc/developer-guides/hld/usb-virt-hld.rst diff --git a/doc/contribute/hld/virtio-blk.rst b/doc/developer-guides/hld/virtio-blk.rst similarity index 100% rename from doc/contribute/hld/virtio-blk.rst rename to doc/developer-guides/hld/virtio-blk.rst diff --git a/doc/contribute/hld/virtio-console.rst b/doc/developer-guides/hld/virtio-console.rst similarity index 100% rename from doc/contribute/hld/virtio-console.rst rename to doc/developer-guides/hld/virtio-console.rst diff --git a/doc/contribute/hld/virtio-input.rst b/doc/developer-guides/hld/virtio-input.rst similarity index 100% rename from doc/contribute/hld/virtio-input.rst rename to doc/developer-guides/hld/virtio-input.rst diff --git a/doc/contribute/hld/virtio-net.rst b/doc/developer-guides/hld/virtio-net.rst similarity index 100% rename from doc/contribute/hld/virtio-net.rst rename to doc/developer-guides/hld/virtio-net.rst diff --git a/doc/contribute/hld/virtio-rnd.rst b/doc/developer-guides/hld/virtio-rnd.rst similarity index 100% rename from doc/contribute/hld/virtio-rnd.rst rename to doc/developer-guides/hld/virtio-rnd.rst diff --git a/doc/contribute/hld/watchdog-hld.rst b/doc/developer-guides/hld/watchdog-hld.rst similarity index 100% rename from doc/contribute/hld/watchdog-hld.rst rename to doc/developer-guides/hld/watchdog-hld.rst diff --git a/doc/contribute/images/GVT-g-porting-image1.png b/doc/developer-guides/images/GVT-g-porting-image1.png similarity index 100% rename from doc/contribute/images/GVT-g-porting-image1.png rename to doc/developer-guides/images/GVT-g-porting-image1.png diff --git a/doc/contribute/images/boot-flow.dot b/doc/developer-guides/images/boot-flow.dot similarity index 100% rename from doc/contribute/images/boot-flow.dot rename to doc/developer-guides/images/boot-flow.dot diff --git a/doc/contribute/images/boot_information_parsing_module.png b/doc/developer-guides/images/boot_information_parsing_module.png similarity index 100% rename from doc/contribute/images/boot_information_parsing_module.png rename to doc/developer-guides/images/boot_information_parsing_module.png diff --git a/doc/contribute/images/circle-square.dot b/doc/developer-guides/images/circle-square.dot similarity index 100% rename from doc/contribute/images/circle-square.dot rename to doc/developer-guides/images/circle-square.dot diff --git a/doc/contribute/images/ept-hierarchy.png b/doc/developer-guides/images/ept-hierarchy.png similarity index 100% rename from doc/contribute/images/ept-hierarchy.png rename to doc/developer-guides/images/ept-hierarchy.png diff --git a/doc/contribute/images/gaspump.dot b/doc/developer-guides/images/gaspump.dot similarity index 100% rename from doc/contribute/images/gaspump.dot rename to doc/developer-guides/images/gaspump.dot diff --git a/doc/contribute/images/modularity-architecture.png b/doc/developer-guides/images/modularity-architecture.png similarity index 100% rename from doc/contribute/images/modularity-architecture.png rename to doc/developer-guides/images/modularity-architecture.png diff --git a/doc/contribute/images/node-shape-edges.dot b/doc/developer-guides/images/node-shape-edges.dot similarity index 100% rename from doc/contribute/images/node-shape-edges.dot rename to doc/developer-guides/images/node-shape-edges.dot diff --git a/doc/contribute/images/record.dot b/doc/developer-guides/images/record.dot similarity index 100% rename from doc/contribute/images/record.dot rename to doc/developer-guides/images/record.dot diff --git a/doc/contribute/images/trusty-arch.png b/doc/developer-guides/images/trusty-arch.png similarity index 100% rename from doc/contribute/images/trusty-arch.png rename to doc/developer-guides/images/trusty-arch.png diff --git a/doc/contribute/images/trusty-boot-flow.dot b/doc/developer-guides/images/trusty-boot-flow.dot similarity index 100% rename from doc/contribute/images/trusty-boot-flow.dot rename to doc/developer-guides/images/trusty-boot-flow.dot diff --git a/doc/contribute/images/vbsk-image1.png b/doc/developer-guides/images/vbsk-image1.png similarity index 100% rename from doc/contribute/images/vbsk-image1.png rename to doc/developer-guides/images/vbsk-image1.png diff --git a/doc/contribute/images/vbsk-image2.png b/doc/developer-guides/images/vbsk-image2.png similarity index 100% rename from doc/contribute/images/vbsk-image2.png rename to doc/developer-guides/images/vbsk-image2.png diff --git a/doc/contribute/images/vbsk-image3.png b/doc/developer-guides/images/vbsk-image3.png similarity index 100% rename from doc/contribute/images/vbsk-image3.png rename to doc/developer-guides/images/vbsk-image3.png diff --git a/doc/contribute/images/work_flow_of_error_detection_and_error_handling.png b/doc/developer-guides/images/work_flow_of_error_detection_and_error_handling.png similarity index 100% rename from doc/contribute/images/work_flow_of_error_detection_and_error_handling.png rename to doc/developer-guides/images/work_flow_of_error_detection_and_error_handling.png diff --git a/doc/contribute/l1tf.rst b/doc/developer-guides/l1tf.rst similarity index 100% rename from doc/contribute/l1tf.rst rename to doc/developer-guides/l1tf.rst diff --git a/doc/contribute/modularity.rst b/doc/developer-guides/modularity.rst similarity index 100% rename from doc/contribute/modularity.rst rename to doc/developer-guides/modularity.rst diff --git a/doc/contribute/sw_design_guidelines.rst b/doc/developer-guides/sw_design_guidelines.rst similarity index 100% rename from doc/contribute/sw_design_guidelines.rst rename to doc/developer-guides/sw_design_guidelines.rst diff --git a/doc/contribute/trusty.rst b/doc/developer-guides/trusty.rst similarity index 100% rename from doc/contribute/trusty.rst rename to doc/developer-guides/trusty.rst diff --git a/doc/extensions/html_redirects.py b/doc/extensions/html_redirects.py new file mode 100644 index 000000000..b2da0dd4a --- /dev/null +++ b/doc/extensions/html_redirects.py @@ -0,0 +1,74 @@ +# Copyright 2018-2019 Espressif Systems (Shanghai) PTE LTD +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + + +# Mechanism to generate static HTML redirect pages in the output +# +# Uses redirect_template.html and the list of pages given in +# conf.html_redirect_pages +# +# Adapted from ideas in https://tech.signavio.com/2017/managing-sphinx-redirects +import os.path + +from sphinx.builders.html import StandaloneHTMLBuilder + +REDIRECT_TEMPLATE = """ + +
+ + + + +Page has moved here.
+ + +""" + + +def setup(app): + app.add_config_value('html_redirect_pages', [], 'html') + app.connect('build-finished', create_redirect_pages) + + # Since we're just setting up a build-finished hook, which runs + # after both reading and writing, this extension is safe for both. + return { + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } + + +def create_redirect_pages(app, docname): + if not isinstance(app.builder, StandaloneHTMLBuilder): + return # only relevant for standalone HTML output + + for (old_url, new_url) in app.config.html_redirect_pages: + if old_url.startswith('/'): + old_url = old_url[1:] + print("Creating redirect: %s.html to %s.html" % (old_url, new_url)) + + new_url = app.builder.get_relative_uri(old_url, new_url) + out_file = app.builder.get_outfilename(old_url) + + out_dir = os.path.dirname(out_file) + if not os.path.exists(out_dir): + os.makedirs(out_dir) + + content = REDIRECT_TEMPLATE.replace("$NEWURL", new_url) + + if not os.path.exists(out_file): + with open(out_file, "w") as rp: + rp.write(content) diff --git a/doc/try/acrn_quick_setup.sh b/doc/getting-started/acrn_quick_setup.sh similarity index 100% rename from doc/try/acrn_quick_setup.sh rename to doc/getting-started/acrn_quick_setup.sh diff --git a/doc/try/apl-nuc.rst b/doc/getting-started/apl-nuc.rst similarity index 100% rename from doc/try/apl-nuc.rst rename to doc/getting-started/apl-nuc.rst diff --git a/doc/develop/building-from-source.rst b/doc/getting-started/building-from-source.rst similarity index 100% rename from doc/develop/building-from-source.rst rename to doc/getting-started/building-from-source.rst diff --git a/doc/try/images/KBL-serial-port-header-to-RS232-cable.jpg b/doc/getting-started/images/KBL-serial-port-header-to-RS232-cable.jpg similarity index 100% rename from doc/try/images/KBL-serial-port-header-to-RS232-cable.jpg rename to doc/getting-started/images/KBL-serial-port-header-to-RS232-cable.jpg diff --git a/doc/try/images/KBL-serial-port-header.png b/doc/getting-started/images/KBL-serial-port-header.png similarity index 100% rename from doc/try/images/KBL-serial-port-header.png rename to doc/getting-started/images/KBL-serial-port-header.png diff --git a/doc/try/images/USB-to-TTL-serial-cable.png b/doc/getting-started/images/USB-to-TTL-serial-cable.png similarity index 100% rename from doc/try/images/USB-to-TTL-serial-cable.png rename to doc/getting-started/images/USB-to-TTL-serial-cable.png diff --git a/doc/try/images/gsg-successful-boot.png b/doc/getting-started/images/gsg-successful-boot.png similarity index 100% rename from doc/try/images/gsg-successful-boot.png rename to doc/getting-started/images/gsg-successful-boot.png diff --git a/doc/try/images/the-bottom-side-of-UP2-board.png b/doc/getting-started/images/the-bottom-side-of-UP2-board.png similarity index 100% rename from doc/try/images/the-bottom-side-of-UP2-board.png rename to doc/getting-started/images/the-bottom-side-of-UP2-board.png diff --git a/doc/try/images/the-connection-of-serial-port.png b/doc/getting-started/images/the-connection-of-serial-port.png similarity index 100% rename from doc/try/images/the-connection-of-serial-port.png rename to doc/getting-started/images/the-connection-of-serial-port.png diff --git a/doc/try/images/up2-gui.png b/doc/getting-started/images/up2-gui.png similarity index 100% rename from doc/try/images/up2-gui.png rename to doc/getting-started/images/up2-gui.png diff --git a/doc/try/up2.rst b/doc/getting-started/up2.rst similarity index 100% rename from doc/try/up2.rst rename to doc/getting-started/up2.rst diff --git a/doc/glossary.rst b/doc/glossary.rst index b8747ae42..83a239b62 100644 --- a/doc/glossary.rst +++ b/doc/glossary.rst @@ -23,9 +23,12 @@ Glossary of Terms A user mode device model application running in Service OS to provide device emulations in ACRN hypervisor. - aperture, Low GM + aperture CPU-visible graphics memory + low GM + see :term:`aperture` + API Application Program Interface: A defined set of routines and protocols for building application software. @@ -77,9 +80,12 @@ Glossary of Terms GVT-s Virtual shared graphics acceleration (multiple VMs to one physical GPU) - Hidden GM, High GM + Hidden GM Hidden or High graphics memory, not visible to the CPU. + High GM + See :term:`Hidden GM` + I2C Inter-Integrated Circuit @@ -113,7 +119,7 @@ Glossary of Terms OSPM Operating System Power Management - Pass-Through Devices + Pass-Through Device Physical devices (typically PCI) exclusively assigned to a guest. In the Project ACRN architecture, pass-through devices are owned by the foreground OS. @@ -127,6 +133,14 @@ Glossary of Terms PM Power Management + Pre-launched VM + Pre-launched VMs are started by the ACRN hypervisor before the + Service VM is launched. (See :term:`Post-launched VM`) + + Post-Launched VM + Post-Launched VMs are launched and configured by the Service VM. + (See :term:`Pre-launched VM`) + PTE Page Table Entry @@ -144,11 +158,33 @@ Glossary of Terms RSE Rear Seat Entertainment + RTVM + Real-time VM. A specially designed VM to run hard real-time or + soft real-time workloads (or application) much more efficiently + than the typical User VM through the use of pass-through interrupt + controller, polling-mode Virtio, Intel Cache Allocation Technology (CAT) + and I/O prioritization. RTVMs are typically a :term:`pre-launched VM`. + A non-:term:`safety VM` with real-time requirements can a + :term:`post-launched VM`. + + Safety VM + A special VM with dedicated hardware resources, running in + partition mode, and providing overall system health-monitoring + functionality. Currently, a Safety VM is always a pre-launched User VM. + SDC Software Defined Cockpit + Service VM + The Service VM is generally the first VM launched by ACRN and can + access hardware resources directly by running native drivers and + provides device sharing services to User VMs via the Device Model. + SOS - Service OS, the privileged guest for ACRN hypervisor + Obsolete, see :term:`Service VM` + + Service OS + Obsolete, see :term:`Service VM` UEFI Unified Extensible Firmare Interface. UEFI replaces the @@ -157,9 +193,14 @@ Glossary of Terms important, support Secure Boot, checking the OS validity to ensure no malware has tampered with the boot process. + User VM + User Virtual Machine. + UOS - User OS (also known as Guest OS), the unprivileged guest for ACRN - hypervisor + Obsolete, see :term:`User VM` + + User OS + Obsolete, see :term:`User VM` vGPU Virtual GPU Instance, created by GVT-g and used by a VM diff --git a/doc/learn/images/IVI-block.png b/doc/introduction/images/IVI-block.png similarity index 100% rename from doc/learn/images/IVI-block.png rename to doc/introduction/images/IVI-block.png diff --git a/doc/learn/images/VMX-brief.png b/doc/introduction/images/VMX-brief.png similarity index 100% rename from doc/learn/images/VMX-brief.png rename to doc/introduction/images/VMX-brief.png diff --git a/doc/learn/images/architecture.png b/doc/introduction/images/architecture.png similarity index 100% rename from doc/learn/images/architecture.png rename to doc/introduction/images/architecture.png diff --git a/doc/learn/images/boot-flow.dot b/doc/introduction/images/boot-flow.dot similarity index 100% rename from doc/learn/images/boot-flow.dot rename to doc/introduction/images/boot-flow.dot diff --git a/doc/learn/images/boot-flow.png b/doc/introduction/images/boot-flow.png similarity index 100% rename from doc/learn/images/boot-flow.png rename to doc/introduction/images/boot-flow.png diff --git a/doc/learn/images/device-model.png b/doc/introduction/images/device-model.png similarity index 100% rename from doc/learn/images/device-model.png rename to doc/introduction/images/device-model.png diff --git a/doc/learn/images/device-passthrough.png b/doc/introduction/images/device-passthrough.png similarity index 100% rename from doc/learn/images/device-passthrough.png rename to doc/introduction/images/device-passthrough.png diff --git a/doc/learn/images/io-emulation-path.png b/doc/introduction/images/io-emulation-path.png similarity index 100% rename from doc/learn/images/io-emulation-path.png rename to doc/introduction/images/io-emulation-path.png diff --git a/doc/learn/images/virtio-architecture.png b/doc/introduction/images/virtio-architecture.png similarity index 100% rename from doc/learn/images/virtio-architecture.png rename to doc/introduction/images/virtio-architecture.png diff --git a/doc/learn/images/virtio-framework-kernel.png b/doc/introduction/images/virtio-framework-kernel.png similarity index 100% rename from doc/learn/images/virtio-framework-kernel.png rename to doc/introduction/images/virtio-framework-kernel.png diff --git a/doc/learn/images/virtio-framework-userland.png b/doc/introduction/images/virtio-framework-userland.png similarity index 100% rename from doc/learn/images/virtio-framework-userland.png rename to doc/introduction/images/virtio-framework-userland.png diff --git a/doc/learn/intro.rst b/doc/introduction/index.rst similarity index 100% rename from doc/learn/intro.rst rename to doc/introduction/index.rst diff --git a/doc/learn/index.rst b/doc/learn/index.rst index 569303794..d76198479 100644 --- a/doc/learn/index.rst +++ b/doc/learn/index.rst @@ -6,5 +6,5 @@ Learn about ACRN .. toctree:: :maxdepth: 1 - intro.rst + ../introduction/index diff --git a/doc/static/acrn-custom.css b/doc/static/acrn-custom.css index d209e5c4c..e1dd083d2 100644 --- a/doc/static/acrn-custom.css +++ b/doc/static/acrn-custom.css @@ -231,8 +231,8 @@ kbd } .grid-item img { - margin-bottom: 1.1rem; - max-width: 75%; + max-width: 50%; + margin-bottom: 0.7rem; } diff --git a/doc/substitutions.txt b/doc/substitutions.txt index 531005937..7540de0d4 100644 --- a/doc/substitutions.txt +++ b/doc/substitutions.txt @@ -17,4 +17,6 @@ :rtrim: .. |micro| unicode:: U+000B5 .. MICRO SIGN :rtrim: +.. |check| unicode:: U+02714 .. HEAVY CHECK MARK + :rtrim: .. |oplus| unicode:: U+02295 .. CIRCLED PLUS SIGN diff --git a/doc/try/index.rst b/doc/try/index.rst index f23f9f26e..ae9671d16 100644 --- a/doc/try/index.rst +++ b/doc/try/index.rst @@ -17,5 +17,6 @@ described in :ref:`hardware`. Follow the setup guides listed here: .. toctree:: :maxdepth: 1 - apl-nuc.rst - up2.rst + ../getting-started/apl-nuc.rst + ../getting-started/up2.rst + ../getting-started/building-from-source.rst diff --git a/doc/develop/acrn-dm-parameters.rst b/doc/user-guides/acrn-dm-parameters.rst similarity index 100% rename from doc/develop/acrn-dm-parameters.rst rename to doc/user-guides/acrn-dm-parameters.rst diff --git a/doc/develop/acrn-shell.rst b/doc/user-guides/acrn-shell.rst similarity index 100% rename from doc/develop/acrn-shell.rst rename to doc/user-guides/acrn-shell.rst diff --git a/doc/develop/images/i915-image1.png b/doc/user-guides/images/i915-image1.png similarity index 100% rename from doc/develop/images/i915-image1.png rename to doc/user-guides/images/i915-image1.png diff --git a/doc/develop/images/i915-image2.png b/doc/user-guides/images/i915-image2.png similarity index 100% rename from doc/develop/images/i915-image2.png rename to doc/user-guides/images/i915-image2.png diff --git a/doc/develop/images/i915-image3.png b/doc/user-guides/images/i915-image3.png similarity index 100% rename from doc/develop/images/i915-image3.png rename to doc/user-guides/images/i915-image3.png diff --git a/doc/develop/images/i915-image4.png b/doc/user-guides/images/i915-image4.png similarity index 100% rename from doc/develop/images/i915-image4.png rename to doc/user-guides/images/i915-image4.png diff --git a/doc/develop/images/i915-image5.png b/doc/user-guides/images/i915-image5.png similarity index 100% rename from doc/develop/images/i915-image5.png rename to doc/user-guides/images/i915-image5.png diff --git a/doc/develop/images/shell_image10.png b/doc/user-guides/images/shell_image10.png similarity index 100% rename from doc/develop/images/shell_image10.png rename to doc/user-guides/images/shell_image10.png diff --git a/doc/develop/images/shell_image11.png b/doc/user-guides/images/shell_image11.png similarity index 100% rename from doc/develop/images/shell_image11.png rename to doc/user-guides/images/shell_image11.png diff --git a/doc/develop/images/shell_image12.png b/doc/user-guides/images/shell_image12.png similarity index 100% rename from doc/develop/images/shell_image12.png rename to doc/user-guides/images/shell_image12.png diff --git a/doc/develop/images/shell_image13.png b/doc/user-guides/images/shell_image13.png similarity index 100% rename from doc/develop/images/shell_image13.png rename to doc/user-guides/images/shell_image13.png diff --git a/doc/develop/images/shell_image14.png b/doc/user-guides/images/shell_image14.png similarity index 100% rename from doc/develop/images/shell_image14.png rename to doc/user-guides/images/shell_image14.png diff --git a/doc/develop/images/shell_image15.png b/doc/user-guides/images/shell_image15.png similarity index 100% rename from doc/develop/images/shell_image15.png rename to doc/user-guides/images/shell_image15.png diff --git a/doc/develop/images/shell_image16.png b/doc/user-guides/images/shell_image16.png similarity index 100% rename from doc/develop/images/shell_image16.png rename to doc/user-guides/images/shell_image16.png diff --git a/doc/develop/images/shell_image17.png b/doc/user-guides/images/shell_image17.png similarity index 100% rename from doc/develop/images/shell_image17.png rename to doc/user-guides/images/shell_image17.png diff --git a/doc/develop/images/shell_image18.png b/doc/user-guides/images/shell_image18.png similarity index 100% rename from doc/develop/images/shell_image18.png rename to doc/user-guides/images/shell_image18.png diff --git a/doc/develop/images/shell_image6.png b/doc/user-guides/images/shell_image6.png similarity index 100% rename from doc/develop/images/shell_image6.png rename to doc/user-guides/images/shell_image6.png diff --git a/doc/develop/images/shell_image7.png b/doc/user-guides/images/shell_image7.png similarity index 100% rename from doc/develop/images/shell_image7.png rename to doc/user-guides/images/shell_image7.png diff --git a/doc/develop/images/shell_image8.png b/doc/user-guides/images/shell_image8.png similarity index 100% rename from doc/develop/images/shell_image8.png rename to doc/user-guides/images/shell_image8.png diff --git a/doc/develop/images/shell_image9.png b/doc/user-guides/images/shell_image9.png similarity index 100% rename from doc/develop/images/shell_image9.png rename to doc/user-guides/images/shell_image9.png diff --git a/doc/develop/kernel-parameters.rst b/doc/user-guides/kernel-parameters.rst similarity index 100% rename from doc/develop/kernel-parameters.rst rename to doc/user-guides/kernel-parameters.rst diff --git a/doc/develop/tools.rst b/doc/user-guides/tools.rst similarity index 100% rename from doc/develop/tools.rst rename to doc/user-guides/tools.rst