Get started guide restructuring and updating (openvinotoolkit#11719)

* Add Overview page * Revert "Add Overview page" * restructure get started home page * update navigation menu * update formatting * update wording * update * rename configurations files * update wording * adjust the structure * update formatting * reverse the heading * test with formatting * 2nd version of Get Started homepage * add line breaks * change to ordered list * update wording * update content * updates * update DL workbench reference * update wording * update references to pip installations * remove redundant files * update headings
yli147 · May 26, 2022 · 1bcdf48 · 1bcdf48
1 parent c185198
commit 1bcdf48
Show file tree

Hide file tree

Showing 12 changed files with 114 additions and 62 deletions.
diff --git a/docs/OV_Runtime_UG/deployment/deployment-manager-tool.md b/docs/OV_Runtime_UG/deployment/deployment-manager-tool.md
@@ -9,11 +9,11 @@ The Deployment Manager is a Python* command-line tool that creates a deployment
    * **For Linux**, see the following sections in the [installation instructions for Linux](../../install_guides/installing-openvino-linux.md):
      * Steps for [Intel® Processor Graphics (GPU)](../../install_guides/configurations-for-intel-gpu.md) section
      * Steps for [Intel® Neural Compute Stick 2 section](../../install_guides/configurations-for-ncs2.md)
-     * Steps for [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs](../../install_guides/installing-openvino-config-ivad-vpu.md)
+     * Steps for [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs](../../install_guides/configurations-for-ivad-vpu.md)
      * Steps for [Intel® Gaussian & Neural Accelerator (GNA)](../../install_guides/configurations-for-intel-gna.md)
    * **For Windows**, see the following sections in the [installation instructions for Windows](../../install_guides/installing-openvino-windows.md):
      * Steps for [Intel® Processor Graphics (GPU)](../../install_guides/configurations-for-intel-gpu.md)
-     * Steps for the [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs](../../install_guides/installing-openvino-config-ivad-vpu.md)
+     * Steps for the [Intel® Vision Accelerator Design with Intel® Movidius™ VPUs](../../install_guides/configurations-for-ivad-vpu.md)
    * **For macOS**, see the following section in the [installation instructions for macOS](../../install_guides/installing-openvino-macos.md):
      * Steps for [Intel® Neural Compute Stick 2 section](../../install_guides/configurations-for-ncs2.md)
 

diff --git a/docs/OV_Runtime_UG/deployment/deployment_intro.md b/docs/OV_Runtime_UG/deployment/deployment_intro.md
@@ -63,6 +63,6 @@ The _optional_ means that if the application does not use the capability enabled
 
 The information above covers granularity aspects of majority distribution types, more detailed information is only needed and provided in [Local Distribution](local-distribution.md).
 
-> **NOTE**: Depending on target OpenVINO devices, you also have to use [Configurations for GPU](../../install_guides/configurations-for-intel-gpu.md), [Configurations for GNA](../../install_guides/configurations-for-intel-gna.md), [Configurations for NCS2](../../install_guides/configurations-for-ncs2.md) or [Configurations for VPU](../../install_guides/installing-openvino-config-ivad-vpu.md) for proper configuration of deployed machines.
+> **NOTE**: Depending on target OpenVINO devices, you also have to use [Configurations for GPU](../../install_guides/configurations-for-intel-gpu.md), [Configurations for GNA](../../install_guides/configurations-for-intel-gna.md), [Configurations for NCS2](../../install_guides/configurations-for-ncs2.md) or [Configurations for VPU](../../install_guides/configurations-for-ivad-vpu.md) for proper configuration of deployed machines.
 
 [deployment_simplified]: ../../img/deployment_simplified.png
diff --git a/docs/_static/css/getstarted_style.css b/docs/_static/css/getstarted_style.css
@@ -24,9 +24,9 @@
 	border-top: solid 1px #fff;
 }
 
-#GSG_introtext a:nth-of-type(1)::after {content: "Select an OS";}
-#GSG_introtext a:nth-of-type(2)::after {content: "From PyPI";}
-#GSG_introtext a:nth-of-type(3)::after {content: "GitHub";}
+#GSG_introtext a:nth-of-type(1)::after {content: "View options";}
+#GSG_introtext a:nth-of-type(2)::after {content: "GPU, NCS2, VPU, GNA";}
+#GSG_introtext a:nth-of-type(3)::after {content: "Tutorials, demos, samples";}
 
 #GSG_introtext a:nth-of-type(1) {margin-left: 0;}
 #GSG_introtext a:nth-of-type(3) {margin-right: 0;}

diff --git a/docs/get_started.md b/docs/get_started.md
@@ -5,39 +5,45 @@
 .. toctree::
    :maxdepth: 1
    :hidden:
-   :caption: Install OpenVINO
+   :caption: Installation & Configuration
 
    Overview <openvino_docs_install_guides_overview>
-   Install OpenVINO Runtime <openvino_docs_install_guides_install_runtime>
-   Install OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>
+   Installing OpenVINO Runtime <openvino_docs_install_guides_install_runtime>
+   Installing OpenVINO Development Tools <openvino_docs_install_guides_install_dev_tools>
    Build from Source <https://github.com/openvinotoolkit/openvino/wiki/BuildingCode>
-   Create a Yocto Image <openvino_docs_install_guides_installing_openvino_yocto>
+   Creating a Yocto Image <openvino_docs_install_guides_installing_openvino_yocto>
+   Additional Configurations <openvino_docs_install_guides_configurations_header>
    Uninstalling <openvino_docs_install_guides_uninstalling_openvino>
 
+<!--
 .. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Additional Configurations
-
+<!--   
    Configurations for GPU <openvino_docs_install_guides_configurations_for_intel_gpu>
    Configurations for NCS2 <openvino_docs_install_guides_configurations_for_ncs2>
    Configurations for VPU <openvino_docs_install_guides_installing_openvino_ivad_vpu>
    Configurations for GNA <openvino_docs_install_guides_configurations_for_intel_gna>
+-->
 
 .. toctree::
    :maxdepth: 1
    :hidden:
    :caption: Get Started Guides
 
-   Get Started with Step-by-step Demo <openvino_docs_get_started_get_started_demos>
-   Get Started with Tutorials <tutorials>
+   Step-by-step Demo <openvino_docs_get_started_get_started_demos>
+   Python Tutorials <tutorials>
+   Code Samples <openvino_docs_OV_UG_Samples_Overview>
 
+<!--
 .. toctree::
    :maxdepth: 1
    :hidden:
    :caption: OpenVINO Code Samples
-
+<!--
    openvino_docs_OV_UG_Samples_Overview
+-->
 
 .. toctree::
    :maxdepth: 1
@@ -50,45 +56,48 @@
 
 @sphinxdirective
 .. raw:: html
-    
+
    <link rel="stylesheet" type="text/css" href="_static/css/getstarted_style.css">
 
-   <p>To get started with OpenVINO, the first thing to do is to actually install it. You can get an <a href="openvino_docs_install_guides_overview.html" >overview</a> of what installation options we provide and start from there. </p>
-
-   <p id="GSG_introtext">If you already have enough information, you can also choose the installation type that best suits your needs from one of the options below:<br />
-     <a href="openvino_docs_install_guides_install_runtime.html" >Install <br />OpenVINO Runtime </a>
-     <a href="openvino_docs_install_guides_install_dev_tools.html" >Install OpenVINO <br />Development Tools</a>
-     <a href="https://github.com/openvinotoolkit/openvino/wiki/BuildingCode" >Build <br /> from source</a>
+   <p id="GSG_introtext">This guide introduces the installation, configuration, and get started guides of Intel® Distribution of OpenVINO™ toolkit. Check the following steps from left to right:<br />
+     <a href="openvino_docs_install_guides_overview.html" >Install Intel® Distribution<br/>of OpenVINO™ toolkit</a>
+     <a href="openvino_docs_install_guides_configurations_header.html" >Perform <br/>Additional Configurations</a>
+     <a href="#get-started-tutorials" >Try <br/>Get Started Steps</a>
+   </p>
+
+   <p>If you prefer using a graphical interface, you can <a href="workbench_docs_Workbench_DG_Start_DL_Workbench_in_DevCloud.html" >Run Deep Learning Workbench in the Intel® DevCloud for the Edge</a>.  Deep Learning Workbench (DL Workbench) is the web version of OpenVINO developed based on Intel® Distribution of OpenVINO™ toolkit with a similar but slightly different function set.</li>
    </p>
    <div style="clear:both;"> </div> 
 
+   <!--
    <p>If you are using Intel® Processor Graphics, Intel® Vision Accelerator Design with Intel® Movidius™ VPUs, Intel® Neural Compute Stick 2 or Intel® Gaussian &amp; Neural Accelerator (GNA), please check the additional configurations for them accordingly: <a href="openvino_docs_install_guides_configurations_for_intel_gpu.html" >Configurations for GPU</a>, <a href="openvino_docs_install_guides_installing_openvino_ivad_vpu.html" >Configurations for VPU</a>, <a href="openvino_docs_install_guides_configurations_for_ncs2.html" >Configurations for NCS2</a> or <a href="openvino_docs_install_guides_configurations_for_intel_gna.html" >Configurations for GNA</a>.
    </p>
+   -->
 
-   <p>With OpenVINO installed, you are ready to run your first inference and learn the workflow. <br /> Here is a set of hands-on demonstrations of various complexity levels to guide you through the process: from performing sample inference with just one command, to running code samples, demo application or Jupyter notebooks. If you prefer working with GUI, you can also get started with the DL Workbench application. This way you can choose the right level for you.<br /></p>
-
-   <h3>Choose how you want to progress:</h3>
+   <h3><a name="get-started-tutorials">Get Started with Tutorials, Demos, and Samples</a></h3>
+   
+   <p>After all the installation and configuration steps are done, you are ready to run your first inference and learn the workflow. Here is a set of hands-on demonstrations of various complexity levels to guide you through the process. You can run code samples, demo applications, or Jupyter notebooks.</p>
 
    <div id="GSG_nextstepchoice">
      <a href="openvino_docs_get_started_get_started_demos.html" >
         <h4>Step-by-step demo		</h4>
         <p>Follow the step-by-step instructions to execute simple tasks with OpenVINO. </p>
      </a>
      <a href="tutorials.html" >
-        <h4>Python Tutorials		</h4>
-        <p>Learn from a choice of interactive Python tutorials targeting typical OpenVINO use cases.	</p>
+        <h4>Python tutorials		</h4>
+        <p>Learn from a choice of interactive Python tutorials targeting typical OpenVINO use cases.</p>
      </a> 		
-     <a href="workbench_docs_Workbench_DG_Introduction.html" >
-        <h4>DL Workbench		</h4>
-        <p>Use a web-based version of OpenVINO with a Graphical User Interface. Installing a DL Workbench container is required. </p>
-     </a> 
      <a href="openvino_docs_OV_UG_Samples_Overview.html" >
         <h4>OpenVINO samples	</h4>
         <p>See ready-made applications explaining OpenVINO features and various use-cases.		</p>
      </a> 
-     <a href="openvino_docs_OV_UG_Samples_Overview.html" >
-        <h4>Reference Implementation For Speech Recognition Apps</h4>
-        <p>Use a speech recognition demo and Kaldi* model conversion tool as reference. </p>
+     <a href="openvino_inference_engine_ie_bridges_python_sample_speech_sample_README.html" >
+        <h4>Reference Implementation For Speech Recognition Apps (Python)</h4>
+        <p>Use a speech recognition demo and Kaldi model conversion tool as reference. </p>
+     </a>
+    <a href="openvino_inference_engine_samples_speech_sample_README.html" >
+        <h4>Reference Implementation For Speech Recognition Apps (C++)</h4>
+        <p>Use a speech recognition demo and Kaldi model conversion tool as reference. </p>
      </a>
      <a href="http://devcloud.intel.com/edge/" >
         <h4>Intel® DevCloud 	</h4>
@@ -97,4 +106,11 @@
    </div>
    <div style="clear:both;"> </div>
 
+<!--
+     <a href="workbench_docs_Workbench_DG_Introduction.html" >
+        <h4>DL Workbench		</h4>
+        <p>Use a web-based version of OpenVINO with a Graphical User Interface. Installing a DL Workbench container is required. </p>
+     </a> 
+-->
+
 @endsphinxdirective
diff --git a/docs/get_started/get_started_demos.md b/docs/get_started/get_started_demos.md
@@ -1,42 +1,49 @@
 # Get Started with Sample and Demo Applications {#openvino_docs_get_started_get_started_demos}
 
-## Introduction
+This guide will walk you through a simplified workflow for the Intel® Distribution of OpenVINO™ toolkit using code samples and demo applications.
 
-This section guides you through a simplified workflow for the Intel® Distribution of OpenVINO™ toolkit using code samples and demo applications.
-You will perform the following steps:
+This guide assumes you have completed all the installation and preparation steps. If you have not, check out the <a href="prerequisites">Prerequisites</a> section to install OpenVINO Runtime, install OpenVINO Development Tools, or build samples and demos.
+
+After that, you will perform the following steps:
 
 1. <a href="#download-models">Use the Model Downloader to download suitable models.</a>
 2. <a href="#convert-models-to-intermediate-representation">Convert the models with the Model Optimizer.</a> 
 3. <a href="#download-media">Download media files to run inference on.</a>
 4. <a href="#run-image-classification">Run inference on the sample and see the results:</a>
     - <a href="#run-image-classification">Image Classification Code Sample</a>
 
-This guide assumes you completed all installation and configuration steps. If you have not yet installed and configured the toolkit:
+## <a name="prerequisites"></a>Prerequisites
+
+### Install OpenVINO Runtime
+
+If you have not yet installed and configured the toolkit, see the following guides:
 
 @sphinxdirective
 .. tab:: Linux
 
-   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for Linux* <openvino_docs_install_guides_installing_openvino_linux>`
+   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for Linux <openvino_docs_install_guides_installing_openvino_linux>`
 
 .. tab:: Windows
 
-   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for Windows* <openvino_docs_install_guides_installing_openvino_windows>`
+   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for Windows <openvino_docs_install_guides_installing_openvino_windows>`
 
 .. tab:: macOS
 
-   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for macOS* <openvino_docs_install_guides_installing_openvino_macos>`
+   See :doc:`Install Intel® Distribution of OpenVINO™ toolkit for macOS <openvino_docs_install_guides_installing_openvino_macos>`
 
 @endsphinxdirective
 
-## Install OpenVINO Development Tools
+### Install OpenVINO Development Tools
 
-To install OpenVINO Development Tools for working with Caffe* models, use the following command: 
+To install OpenVINO Development Tools for working with Caffe models, use the following command: 
 
 ``` sh
    pip install openvino-dev[caffe]
 ```
 
-## Build Samples and Demos
+For more detailed steps, see [Install OpenVINO™ Development Tools](../install_guides/installing-model-dev-tools.md)
+
+### Build Samples and Demos
 
 If you have already built the demos and samples, you can skip this section. The build will take about 5-10 minutes, depending on your system.
 
@@ -45,31 +52,33 @@ To build OpenVINO samples:
 @sphinxdirective
 .. tab:: Linux
 
-   Go to the :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on Linux*" section.
+   Go to :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on Linux" section.
 
 .. tab:: Windows
 
-   Go to the :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on Microsoft Windows* OS" section.
+   Go to :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on Microsoft Windows OS" section.
 
 .. tab:: macOS
 
-   Go to the :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on macOS*" section. 
+   Go to :doc:`OpenVINO Samples page <openvino_docs_OV_UG_Samples_Overview>` and see the "Build the Sample Applications on macOS" section. 
 
 @endsphinxdirective
 
 To build OpenVINO demos:
+
 @sphinxdirective
+
 .. tab:: Linux
 
-   Go to the :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Linux*" section.
+   Go to :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Linux" section.
 
 .. tab:: Windows
 
-   Go to the :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Microsoft Windows* OS" section.
+   Go to :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Microsoft Windows OS" section.
 
 .. tab:: macOS
 
-   Go to the :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Linux*" section. You can use the requirements from "To build OpenVINO samples" above and adapt the Linux build steps for macOS*.
+   Go to :doc:`Open Model Zoo Demos page <omz_demos>` and see the "Build the Demo Applications on Linux*" section. You can use the requirements from "To build OpenVINO samples" above and adapt the Linux build steps for macOS.
 
 @endsphinxdirective
 
@@ -122,7 +131,7 @@ This guide uses the OpenVINO™ Model Downloader to get pre-trained models. You
 
 @endsphinxdirective
 
-To download the GoogleNet v1 Caffe* model to the `models` folder:
+To download the GoogleNet v1 Caffe model to the `models` folder:
 
 @sphinxdirective
 
@@ -222,6 +231,7 @@ The googlenet-v1 model is downloaded in the Caffe* format. You must use the Mode
 Create an `<ir_dir>` directory to contain the model's Intermediate Representation (IR).
 
 @sphinxdirective
+
 .. tab:: Linux
 
    .. code-block:: sh
@@ -255,6 +265,7 @@ IR files produced by the script are written to the <ir_dir> directory.
 The command with most placeholders filled in and FP16 precision:
 
 @sphinxdirective
+
 .. tab:: Linux
 
    .. code-block:: sh

diff --git a/docs/install_guides/movidius-setup-guide.md → ...all_guides/configurations-for-iei-card.md b/docs/install_guides/movidius-setup-guide.md → ...all_guides/configurations-for-iei-card.md
@@ -1,10 +1,10 @@
 # Configurations for IEI Mustang-V100-MX8-R10 card {#openvino_docs_install_guides_movidius_setup_guide}
 
-> **NOTE**: These steps are only required for **IEI Mustang-V100-MX8-R10** card. **IEI Mustang-V100-MX8-R11** card doesn't require any additional steps and it's completely configured using the [general guidance](installing-openvino-config-ivad-vpu.md).      
+> **NOTE**: These steps are only required for **IEI Mustang-V100-MX8-R10** card. **IEI Mustang-V100-MX8-R11** card doesn't require any additional steps and it's completely configured using the [general guidance](configurations-for-ivad-vpu.md).      
 
 
 The IEI Mustang-V100-MX8 is an OEM version of the Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
-This guide assumes you have installed the [Mustang-V100-MX8](https://download.ieiworld.com/) and the [Intel® Distribution of OpenVINO™ toolkit](https://software.intel.com/content/www/us/en/develop/tools/openvino-toolkit.html).
+This guide assumes you have installed the [Mustang-V100-MX8](https://download.ieiworld.com/) and Intel® Distribution of OpenVINO™ toolkit.
 
 Instructions in this guide for configuring your accelerator include:
 1.	Installing the required IEI BSL reset software

diff --git a/...es/installing-openvino-config-ivad-vpu.md → ...all_guides/configurations-for-ivad-vpu.md b/...es/installing-openvino-config-ivad-vpu.md → ...all_guides/configurations-for-ivad-vpu.md
@@ -44,7 +44,7 @@ Now the dependencies are installed and you are ready to use the Intel® Vision A
 
 ### Optional Steps
 
-For advanced configuration steps for your **IEI Mustang-V100-MX8-R10** accelerator, see [Configurations for IEI Mustang-V100-MX8-R10 card](movidius-setup-guide.md). **IEI Mustang-V100-MX8-R11** accelerator doesn't require any additional steps. 
+For advanced configuration steps for your **IEI Mustang-V100-MX8-R10** accelerator, see [Configurations for IEI Mustang-V100-MX8-R10 card](configurations-for-iei-card.md). **IEI Mustang-V100-MX8-R11** accelerator doesn't require any additional steps. 
 
 @sphinxdirective
 
@@ -63,6 +63,6 @@ To enable inference on Intel® Vision Accelerator Design with Intel® Movidius
 
 You are done installing your device driver and are ready to use your Intel® Vision Accelerator Design with Intel® Movidius™ VPUs.
 
-For advanced configuration steps for your IEI Mustang-V100-MX8 accelerator, see [Configurations for IEI Mustang-V100-MX8-R10 card](movidius-setup-guide.md).
+For advanced configuration steps for your IEI Mustang-V100-MX8 accelerator, see [Configurations for IEI Mustang-V100-MX8-R10 card](configurations-for-iei-card.md).
 
 After configuration is done, you are ready to go to <a href="openvino_docs_install_guides_installing_openvino_windows.html#get-started">Start Using the Toolkit</a> section to learn the basic OpenVINO™ toolkit workflow and run code samples and demo applications.