Add ReportVision Product Walthrough Video and Azure Infra Architecture (

#521) * remove old video and include rv full product walthrough video * update with azure diagram and demo video * Update README.md demo link * Update README.md revised disgram * Remove table of contents reference after video * Fix Notices Section * Add Return Table of Contents Reference to Infra Arch Section * update ops/terraform README and resolve conflicts * Update README.md's architectural design * save updated architectural design to images-and-media folder * Update ops/terraform/README.md with revised Architecture diagram * update images-and-media with revised architecture diagram * update images-and-media with revised architecture * Remove Extra Text Box in Architecture for ops/terraform * Remove extra text box from architecture in main README * Update README.md * Update ops/terraform README.md --------- Co-authored-by: marycrawford <[email protected]>
CDCgov · Jan 21, 2025 · cf6985a · cf6985a
1 parent b2cebd3
commit cf6985a
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -4,19 +4,21 @@
 - [The Solution](#the-solution)
 - [Future Considerations](#future-considerations)
 
-[2. Notices](#2-notices)
-- [2.1 Privacy Standard Notice](#21-privacy-standard-notice)
-- [2.2 Records Management Standard Notice](#22-records-management-standard-notice)
-- [2.3 Domestic Copyright Protection Notice](#23-domestic-copyright-protection-notice)
-- [2.4 Public Domain Standard Notice](#24-public-domain-standard-notice)
-- [2.5 Open Source Notice](#25-open-source-notice)
-- [2.6 License Standard Notice](#26-license-standard-notice)
-- [2.7 Github Notice](#27-github-notice)
-- [2.8 Contributing Standard Notice](#28-contributing-standard-notice)
+[2. Infrastructure Architecture](#2-infrastructure-architecture)
 
-[3. General Disclaimer](#3-general-disclaimer)
+[3. Notices](#3-notices)
+- [3.1 Privacy Standard Notice](#31-privacy-standard-notice)
+- [3.2 Records Management Standard Notice](#32-records-management-standard-notice)
+- [3.3 Domestic Copyright Protection Notice](#33-domestic-copyright-protection-notice)
+- [3.4 Public Domain Standard Notice](#34-public-domain-standard-notice)
+- [3.5 Open Source Notice](#35-open-source-notice)
+- [3.6 License Standard Notice](#36-license-standard-notice)
+- [3.7 Github Notice](#37-github-notice)
+- [3.8 Contributing Standard Notice](#38-contributing-standard-notice)
 
-[4. Other Related Documents](#4-other-related-documents)
+[4. General Disclaimer](#4-general-disclaimer)
+
+[5. Other Related Documents](#5-other-related-documents)
 
 
 # 1. Overview
@@ -38,31 +40,34 @@ With ReportVision, public health departments can move from cumbersome, error-pro
 
 This application offers a robust framework for public health departments and personnel to efficiently extract relevant data from lab reports utilizing an advanced Optical Character Recognition (OCR) model.  This OCR technology significantly enhances both the speed and accuracy of data extraction, taking your data processing capabilities to the next level.  
 
-Check out the following videos to see how the updated OCR model works in action, and and witness firsthand how ReportVision enhances both the speed and accuracy of data extraction!
+Check out the following video which demos the ReportVision application including how the updated OCR model works in action, and witness firsthand how ReportVision enhances both the speed and accuracy of data extraction!
 
-<div align="center">
-<video width="500" height="280" controls>
-  <source src="/images-and-media/reportvision-demo.mp4" type="video/mp4">
-  Video Extracting Data From Lab Reports.
-</video>
-</div align="center">
+https://github.com/user-attachments/assets/5b707ec2-5d11-436b-a270-98000ef21e8f
 
 ## Future Considerations
 
 The current version of the application is optimized only for PDF-based lab reports. However, as demand from public health departments and personnel continues to grow, we see significant potential to expand support for additional file formats in future updates.
 
 + [Return to Table of Contents](#table-of-contents).
 
-# 2. Notices
+# 2. Infrastructure Architecture
+
+The following provides a High-Level Architectural Design of the ReportVision Azure Architecture, with OCR powered by Tesseract to enhance efficiency, user experience, and throughput.
+
+<img width="998" alt="rv-azure-architecture-diagram" src="https://github.com/user-attachments/assets/5c73c2e7-4b38-4527-8df0-ec5beb1eaf5e" />
+
++ [Return to Table of Contents](#table-of-contents).
+
+# 3 Notices
 
-## 2.1 Privacy Standard Notice
+## 3.1 Privacy Standard Notice
 This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the [Disclaimer](DISCLAIMER.md) and [Code of Conduct](code-of-conduct.md).
 
 For more information about CDC's privacy policy, please visit [http://www.cdc.gov/other/privacy.html](https://www.cdc.gov/other/privacy.html).
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.2 Records Management Standard Notice
+## 3.2 Records Management Standard Notice
 
 This repository is not a source of government records, but is a copy to increase
 collaboration and collaborative potential. All government records will be
@@ -71,13 +76,13 @@ published through the [CDC web site](http://www.cdc.gov).
 + [Return to Table of Contents](#table-of-contents).
 
 
-## 2.3 Domestic Copyright Protection Notice
+## 3.3 Domestic Copyright Protection Notice
 
 This repository is a work of the United States Government and is not subject to domestic copyright protection under 17 U.S.C. § 105. If published in the public domain within the United States, copyright and related rights worldwide will be waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.4 Public Domain Standard Notice
+## 3.4 Public Domain Standard Notice
 This repository constitutes a work of the United States Government and is not
 subject to domestic copyright protection under 17 USC § 105. This repository is in
 the public domain within the United States, and copyright and related rights in
@@ -88,13 +93,13 @@ copyright interest.
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.5 Open Source Notice
+## 3.5 Open Source Notice
 
 This repository is open source and follows [open practices](docs/open_practices.md).  Contributors are expected to adhere to the organization's [rules of behavior](docs/rules_of_behavior.md).  
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.6 License Standard Notice
+## 3.6 License Standard Notice
 
 The code in this repository is licensed under the Apache License 2.0 (ASL v2), or any later version at your discretion.
 
@@ -106,14 +111,14 @@ Additionally, any code forked from this open-source project will retain its orig
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.7 Github Notice
+## 3.7 Github Notice
 
 GitHub is not hosted by the CDC, but is a third party website used by CDC and its partners to share information and collaborate on software. CDC use of GitHub does not imply an endorsement of any one particular service, product, or enterprise. If you are new to GitHub, we recommend starting with this
 [basic tutorial](https://help.github.com/articles/set-up-git) to familiarize yourself with version control and collaboration.  
 
 + [Return to Table of Contents](#table-of-contents).
 
-## 2.8 Contributing Standard Notice
+## 3.8 Contributing Standard Notice
 
 While we encourage continuous development of this repository's codebase, there is currently no designated department overseeing its management. If you'd like to contribute, you have two options:
 
@@ -127,18 +132,18 @@ CDC including this GitHub page may be subject to applicable federal law, includi
 
 + [Return to Table of Contents](#table-of-contents).
 
-# 3. General Disclaimer
+# 4. General Disclaimer
 
 This repository was created for use by CDC programs to collaborate on public health related projects in support of the [CDC mission](https://www.cdc.gov/about/cdc/?CDC_AAref_Val=https://www.cdc.gov/about/organization/mission.htm).  
 
 + [Return to Table of Contents](#table-of-contents).
 
-# 4. Other Related Documents
+# 5. Other Related Documents
 
 * [Open Practices](docs/open_practices.md)
 * [Rules of Behavior](docs/rules_of_behavior.md)
 * [Disclaimer](docs/DISCLAIMER.md)
 * [Contribution Notice](docs/CONTRIBUTING.md)
 * [Code of Conduct](docs/code-of-conduct.md)
 * [Review Guidelines](docs/REVIEW_GUIDELINES.md)
-* [Review SLAS](docs/REVIEW_SLAS.md)
+* [Review SLAS](docs/REVIEW_SLAS.md)
diff --git a/images-and-media/reportvision-demo.mp4 b/images-and-media/reportvision-demo.mp4
diff --git a/images-and-media/rv-azure-architecture-diagram.png b/images-and-media/rv-azure-architecture-diagram.png
diff --git a/images-and-media/rv-full-product-waklthrough.mp4 b/images-and-media/rv-full-product-waklthrough.mp4
diff --git a/ops/terraform/README.md b/ops/terraform/README.md
@@ -2,6 +2,10 @@
 
 Currently, our infrastructure is built specifically for Azure, with a traditional cloud architecture hosting our frontend code from blob storage and our OCR-API, Middleware-API running in App Service's. The frontend, OCR-API, Middleware-API, and the Postgres Database are behind a Virtual Network and load balanced by an App Gateway.
 
+This diagram provides a high-level overview of our Azure architectural design.
+
+<img width="998" alt="rv-azure-architecture-diagram" src="https://github.com/user-attachments/assets/5c73c2e7-4b38-4527-8df0-ec5beb1eaf5e" />
+
 ## List of Azure Services being used
 
 - Resource Groups
@@ -90,4 +94,4 @@ once Purge Protection has been Enabled it's not possible to disable it
 ```
 This is a valid and expected error because we do not want to purge the secret for the database. We implemented this change right before our contract ended and ran out of time to fix it(We started looking into possibly making it a warning instead of an error).
 
-All the updating changes should still apply even with this error but it definitely is blocking Github Actions from working properly for this process to be fully automated.
+All the updating changes should still apply even with this error but it definitely is blocking Github Actions from working properly for this process to be fully automated.