[DOCS][Metro] IBVS - tocrev 2 (open-edge-platform#1695)

wiwaszko-intel · web-flow · commit 1e6e0b9836d2 · 2026-02-10T09:39:40.000+05:30
diff --git a/metro-ai-suite/image-based-video-search/README.md b/metro-ai-suite/image-based-video-search/README.md
@@ -36,11 +36,12 @@ The application includes a demonstration video for testing. The video loops cont
 ![Screenshot of the Image-Based Video Search sample application interface displaying search input and matched results](./docs/user-guide/_assets/imagesearch2.png)
 
 ### Learn More
+
 - [Get Started](./docs/user-guide/get-started.md)
-- [System Requirements](./docs/user-guide/system-requirements.md)
+- [System Requirements](./docs/user-guide/get-started/system-requirements.md)
 - [How It Works](./docs/user-guide/how-it-works.md)
-- [How to Deploy with Helm](./docs/user-guide/how-to-deploy-helm.md)
-- [How to Deploy with Edge Orchestrator](./docs/user-guide/how-to-deploy-with-edge-orchestrator.md)
+- [Deploy with Helm](./docs/user-guide/get-started/deploy-with-helm.md)
+- [Deploy with Edge Orchestrator](./docs/user-guide/get-started/deploy-with-edge-orchestrator.md)
 - [Release Notes](./docs/user-guide/release-notes.md)
 
 ## Important Notice
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/get-started.md b/metro-ai-suite/image-based-video-search/docs/user-guide/get-started.md
@@ -1,25 +1,18 @@
 # Get Started
 
-<!--
-**Sample Description**: Provide a brief overview of the application and its purpose.
--->
 The **Image-Based Video Search**  is a sample application that demonstrates how developers can leverage edge AI technologies to solve real-world challenges. It enables efficient processing and searching of video data to identify objects of interest, providing actionable insights in real-time.
 
 This application showcases searching through video data generated by cameras around a city to find the closest match to the user-provided image.
 
-<!--
-**What You Can Do**: Highlight the developer workflows supported by the guide.
--->
 By following this guide, you will learn how to:
 - **Set up the sample application**: Use Docker Compose to quickly deploy the application in your environment.
 - **Run a predefined pipeline**: Execute a sample pipeline to see real-time traffic monitoring and object detection in action.
 - **Modify application parameters**: Customize settings like input sources and detection thresholds to adapt the application to your specific requirements.
 
-
 ## Prerequisites
-- Verify that your system meets the [minimum requirements](./system-requirements.md).
-- Install Docker: [Installation Guide](https://docs.docker.com/get-docker/).
 
+- Verify that your system meets the [minimum requirements](./get-started/system-requirements.md).
+- Install Docker: [Installation Guide](https://docs.docker.com/get-docker/).
 
 ## Set up and First Use
 
@@ -33,9 +26,6 @@ By following this guide, you will learn how to:
     > **Note:** The below step is required for deployment with certain pre-release images
     - Update `DOCKER_REGISTRY` variable in `.env` file present at `edge-ai-suites/metro-ai-suite/image-based-video-search/`. The recommended setting to use pre-release images is: `DOCKER_REGISTRY=docker.io/`
       Please remember to include `/` at the end.
-<!--
-a pre-step to prepare models may be needed
--->
 
 2. **Build from Source (Optional)**:
     - Run the below command to build the images from source
@@ -136,7 +126,6 @@ a pre-step to prepare models may be needed
       - Stream UI: You can access https stream at `https://<ip-addr>/stream` and RTSP stream at `rtsp://<ip-addr>:8554/stream`.
     > **Note:** Replace `<ip-addr>` with your host IP address
 
-
 7. **Run the Application**:
 
     - **Analyze Stream**: Use the predefined video and click **Analyze Stream** to start processing the video stream.
@@ -300,30 +289,18 @@ a pre-step to prepare models may be needed
        docker compose logs
        ```
 
+## Supporting Resources
 
-## Troubleshooting
-
-1. **Containers Not Starting**:
-   - Check the Docker logs for errors:
-     ```bash
-     docker compose logs
-     ```
-2. **Port Conflicts**:
-   - Update the `ports` section in the Compose file to resolve conflicts.
-
-3. **ibvs-milvusdb container is unhealthy**:
-   - Currently, milvusdb does not work with proxy servers. Make sure that the proxies `http_proxy`, `https_proxy` and `no_proxy` are set to empty string in `compose.yml` file
-
-4. **Empty search results after clicking on `Search Object`**:
-   - Make sure the models are able to detect the objects in the stream correctly
-   - Make sure you have analysed the stream first to capture the video frames into milvus database
-   - Make sure you are using the right frame to search the object
-   - Increase the 'To' timestamp in the search results to accommodate the latest results
+- [Troubleshooting](./troubleshooting.md)
+- [Docker Compose Documentation](https://docs.docker.com/compose/)
 
-5. **Failure to launch `ibvs-app`, `ibvs-featurematching` or `ibvs-streaming` containers**:
-   - In case one of the above containers fails to come up, try building the image locally as mentioned in Step 2 of [Set up and First Use](#set-up-and-first-use) before bringing up the containers.
+<!--hide_directive
+:::{toctree}
+:hidden:
 
-## Supporting Resources
-- [Docker Compose Documentation](https://docs.docker.com/compose/)
+get-started/system-requirements.md
+get-started/deploy-with-helm.md
+get-started/deploy-with-edge-orchestrator.md
 
-<!-- - [Community Forum](https://community.example.com) -->
+:::
+hide_directive-->
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/deploy-with-edge-orchestrator.md b/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/deploy-with-edge-orchestrator.md
@@ -34,7 +34,7 @@ To deploy the **Image-Based Video Search** application with Edge Orchestrator, f
 
 3. Once the deployment package has been imported into Edge Orchestrator, you can see it in the list of Web UI as shown here.
 
-![Image](./_assets/ibvs-dp.png)
+![Image](../_assets/ibvs-dp.png)
 
 See [Deployment Packages](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/package_software/deploy_packages.html#view-deployment-packages) for more information on deployment packages.
 
@@ -78,6 +78,6 @@ For more information on setting up a deployment, see [Set up a Deployment](https
 
 1. Download the kubeconfig of the cluster of the Edge Node on which the Application has been deployed. Refer [Kubeconfig Download](https://docs.openedgeplatform.intel.com/edge-manage-docs/dev/user_guide/set_up_edge_infra/clusters/accessing_clusters.html).
 
-1. Follow the steps described in the **Image-Based Video Search** [Documentation](./how-to-deploy-helm.md) on usage of the application.
+1. Follow the steps described in the **Image-Based Video Search** [Documentation](./deploy-with-helm.md) on usage of the application.
 
    > **Note:** Skip the install the Helm chart step.
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/deploy-with-helm.md b/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/deploy-with-helm.md
@@ -73,33 +73,8 @@ Before You Begin, ensure the following:
     helm uninstall -n ibvs ibvs
     ```
 
-## Troubleshooting
-
-1. **Helm Chart Not Found**:
-
-   - Check if the Helm repository was added:
-
-     ```bash
-     helm repo list
-     ```
-
-1. **Pods Not Running**:
-
-   - Review pod logs:
-
-     ```bash
-     kubectl logs {{pod-name}} -n {{namespace}}
-     ```
-
-1. **Service Unreachable**:
-
-   - Confirm the service configuration:
-
-     ```bash
-     kubectl get svc -n {{namespace}}
-     ```
-
 ## Supporting Resources
 
+- [Troubleshooting Helm Deployments](../troubleshooting.md#troubleshooting-helm-deployments)
 - [Kubernetes Documentation](https://kubernetes.io/docs/home/)
 - [Helm Documentation](https://helm.sh/docs/)
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/system-requirements.md b/metro-ai-suite/image-based-video-search/docs/user-guide/get-started/system-requirements.md
@@ -13,7 +13,6 @@ help you set up and run the application efficiently.
 **Hardware Platforms**
 - 12th Generation Intel® Core™ processor or above with Intel® HD Graphics or , or Intel® Xeon® processor
 
-
 ## Minimum Requirements
 | **Component**      | **Minimum Requirement**   | **Recommended**         |
 |---------------------|---------------------------|--------------------------|
@@ -38,4 +37,4 @@ help you set up and run the application efficiently.
 ## Validation
 
 - Ensure all dependencies are installed and configured before proceeding to
-  [Get Started](./get-started.md).
+  [Get Started](../get-started.md).
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/how-to-use-gpu-for-inference.md b/metro-ai-suite/image-based-video-search/docs/user-guide/how-to-use-gpu-for-inference.md
@@ -3,12 +3,13 @@
 ## Docker deployment
 ### Prerequisites
 
-Follow steps 1 and 2 mentioned in [Get Started](./get-started.md#set-up-and-first-use) guide if not already done.
+Follow steps 1 and 2 mentioned in [Get Started](./get-started.md#set-up-and-first-use) guide
+if not already done.
 
 ### Volume mount GPU config
 
-Comment out CPU and NPU config and uncomment the GPU config present in [`compose.yml`](https://github.com/open-edge-platform/edge-ai-suites/blob/main/metro-ai-suite/image-based-video-search/compose.yml) file
-under `volumes` section as shown below:
+Comment out CPU and NPU config and uncomment the GPU config present in [compose.yml](https://github.com/open-edge-platform/edge-ai-suites/blob/main/metro-ai-suite/image-based-video-search/compose.yml)
+file under `volumes` section as shown below:
 
 ```sh
     volumes:
@@ -24,7 +25,7 @@ After the above changes to docker compose file, follow from step 3 as mentioned
 
 ## Helm deployment
 ### Prerequisites
-Follow step 1 mentioned in this [document](./how-to-deploy-helm.md#steps-to-deploy) if not already done.
+Follow step 1 mentioned in this [document](./get-started/deploy-with-helm.md#steps-to-deploy) if not already done.
 
 ### Update values.yaml
 
@@ -49,4 +50,5 @@ dlstreamerpipelineserver:
 
 ### Start the application
 
-After above changes to `values.yaml` file, follow from step 2 as mentioned in this [document](./how-to-deploy-helm.md#steps-to-deploy).
+After above changes to `values.yaml` file, follow from step 2 as mentioned in the
+[Helm Deployment Guide](./get-started/deploy-with-helm.md#steps-to-deploy).
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/index.md b/metro-ai-suite/image-based-video-search/docs/user-guide/index.md
@@ -1,4 +1,4 @@
-# Image-Based Video Search Sample Application
+# Image-Based Video Search
 
 <!--hide_directive
 <div class="component_card_widget">
@@ -11,7 +11,7 @@
 </div>
 hide_directive-->
 
-Performs near real-time analysis and image-based search to detect and retrieve
+Image-based Video Search sample application performs near real-time analysis and image-based search to detect and retrieve
 objects of interest in large video datasets.
 
 ## Overview
@@ -30,9 +30,10 @@ quickly locate objects of interest across large video datasets.
 
 ## How it Works
 
-The application workflow has three stages: inputs, processing, and outputs.
+The application workflow consists of three stages: inputs, processing, and outputs.
 
 ![architectural diagram](./_assets/architecture.svg)
+*Figure 1: Detailed Architecture of the Image-Based Video Search Application.*
 
 ### Inputs
 
@@ -44,12 +45,12 @@ continuously and appears in the UI as soon as the application starts.
 
 ### Processing
 
-- **Nginx reverse proxy server**: All interactions with user happens via Nginx server. It protects IBVS app by handling SSL/TLS encryption, filtering and validating requests and making the app directly inaccessible from external access.
+- **Nginx reverse proxy server**: All interactions with user happens via Nginx server. It protects the IBVS app by handling SSL/TLS encryption, filtering and validating requests, offering centralized access control and making the app directly inaccessible from external access.
 - **Video analysis with Deep Learning Streamer Pipeline Server and MediaMTX**:
   Select **Analyze Stream** to start the DL Streamer Pipeline Server pipeline.
   The Pipeline Server processes video through **MediaMTX**, which simulates
   remote video cameras and publishes live streams. The Pipeline Server extracts
-  frames and detects objects in each frame, publishing predictions through
+  frames from RTSP streams and detects objects in each frame, publishing predictions through
   **MQTT**.
 - **Feature extraction with Feature Matching**: DL Streamer Pipeline Server
   sends metadata and images through MQTT to the Feature Matching microservice.
@@ -75,7 +76,7 @@ continuously and appears in the UI as soon as the application starts.
 
 ## Learn More
 - [Get Started](./get-started.md)
-- [System Requirements](./system-requirements.md)
+- [System Requirements](./get-started/system-requirements.md)
 - [Release Notes](./release-notes.md)
 - [DL Streamer Pipeline Server](https://docs.openedgeplatform.intel.com/dev/edge-ai-libraries/dlstreamer-pipeline-server/index.html)
 
@@ -84,9 +85,6 @@ continuously and appears in the UI as soon as the application starts.
 :hidden:
 
 get-started
-system-requirements
-how-to-deploy-helm
-how-to-deploy-with-edge-orchestrator
 how-it-works
 how-to-use-gpu-for-inference
 troubleshooting
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/release-notes.md b/metro-ai-suite/image-based-video-search/docs/user-guide/release-notes.md
@@ -1,34 +1,9 @@
-<!--
-# How to Use This Template
-
-1. **Purpose**:
-   - Summarize new features, improvements, bug fixes, and known issues for each release.
-   - Help developers quickly understand updates and adapt workflows accordingly.
-
-2. **Content Customization**:
-   - Replace placeholders (e.g., `[Version X.X.X]`, `[YYYY-MM-DD]`, `<description>`) with specific release details.
-   - Refer to the user stories in comments to understand what information developers expect to find.
-
-3. **Style Guidelines**:
-   - Use bullet points and concise descriptions for clarity.
-   - Organize changes by category: New Features, Improvements, Bug Fixes, and Known Issues.
-   - Use active voice and developer-focused language.
-   - Follow the **Microsoft Developer Writing Style Guide**.
-
-4. **GitHub Copilot Can Help**:
-   - **For Style Adherence**:
-     - This template specifys the style guide to be followed, ask Copilot to check.
-     - Copilot can generate suggestions in line with the specified writing style.
-   - **To Validate Content Completeness**:
-     - The template includes in comments the user stories and acceptance criteria to be fulfilled by its content in each section. Copilot can check if you included all required information.
-5. **Validation**:
-   - Verify all details, links, and formatting before publishing.
-   - Ensure that descriptions are accurate and actionable.
-
--->
-
 # Release Notes
 
+- [Version 1.1.0](#version-110)
+- [Version 1.0.1](#version-101)
+- [Version 1.0.0](#version-100)
+
 Details about the changes, improvements, and known issues in this release of the
 application.
 
@@ -40,26 +15,15 @@ application.
 
 ## Version 1.0.1
 
-**Release Date**: [2025-08-20]
+**Release Date**: 2025-08-20
 
 - DL Streamer version upgraded to 2025.1.2
 - DL Streamer Pipeline Server version upgraded to 3.1.0
 - Bug fixes
 
 ## Version 1.0.0
 
-**Release Date**: [2025-03-31]
-<!--
-**Guidelines for New Features**:
-1. **What to Include**:
-   - Summarize new capabilities introduced in this release.
-   - Highlight how these features help developers or solve common challenges.
-   - Link to relevant guides or instructions for using the feature.
-2. **Example**:
-   - **Feature**: Added multi-camera configuration support.
-     - **Benefit**: Enables developers to monitor larger areas in real-time.
-     - [Learn More](./how-to-customize.md)
--->
+**Release Date**: 2025-03-31
 
 - **MediaMTX**: This third-party microservice simulates remote video cameras
   placed in various geographical locations. The service can replay videos from
diff --git a/metro-ai-suite/image-based-video-search/docs/user-guide/troubleshooting.md b/metro-ai-suite/image-based-video-search/docs/user-guide/troubleshooting.md
