A PR preview is available: Preview URL

A PR preview is available: Preview URL

PR Summary

This pull request introduces several significant enhancements to the documentation of the ValidMind platform. The key changes include:

1. New Deployment Options Section: A new section has been added to the documentation to describe the different deployment options available for ValidMind. This includes detailed descriptions of the multi-tenant cloud and Virtual Private ValidMind (VPV) deployment models.

   • Multi-tenant Cloud: Allows multiple customers to share the same infrastructure while ensuring strict data isolation.
   • Virtual Private ValidMind (VPV): A single-tenant architecture providing greater control, customization, and enhanced security.

2. Azure Private Link Configuration: A new guide has been added to help users configure Azure Private Link for secure and private communication between Azure Virtual Network (VNet) resources and ValidMind.

3. Updates to Existing Documentation: Minor updates have been made to existing documentation to align with the new deployment options and to improve clarity. This includes changes to the data privacy policy and API integration descriptions.

4. New Images and Diagrams: New images and diagrams have been added to visually represent the deployment options and the architecture of the ValidMind platform.

These changes aim to provide users with comprehensive information on deployment options and enhance the security and privacy of their network configurations.

Test Suggestions

• Verify that the new deployment options section is correctly rendered and accessible in the documentation.
• Check the links and references in the new deployment options section to ensure they point to the correct resources.
• Test the Azure Private Link configuration guide by following the steps to set up a private endpoint and verify connectivity.
• Ensure that the images and diagrams are correctly displayed and have appropriate alt text for accessibility.
• Review the updated data privacy policy and API integration sections for accuracy and clarity.

@cachafla @validbeck my apologies, I had not changed the title of the PR before requesting review from you — this PR includes the docs for the deployment architecture info we had talked about.

PR Summary

This pull request introduces several enhancements to the documentation of the ValidMind platform, focusing on deployment options and secure network configurations. The key changes include:

1. Deployment Options Documentation: A new section titled "Deployment options" has been added, detailing the available deployment models for ValidMind:

   • Multi-tenant Cloud: This model allows multiple organizations to share infrastructure while maintaining data isolation. It offers cost-efficiency, scalability, and centralized updates.
   • Virtual Private ValidMind (VPV): A single-tenant architecture providing exclusive infrastructure access, ideal for high-compliance needs with enhanced security and control.

2. Azure Private Link Configuration: A new guide has been added to configure Azure Private Link, enabling secure and private communication between Azure Virtual Network resources and ValidMind. This guide includes step-by-step instructions for setting up a private endpoint and ensuring secure access to ValidMind services.

3. Security and Data Privacy Enhancements: The documentation now emphasizes data security measures, including data isolation, encryption, and role-based access controls. It also highlights compliance with SOC 2 standards and the absence of PII in API communications.

4. Minor Textual Updates: Adjustments have been made to the language in various files to improve clarity and consistency, such as changing references from "SaaS API" to "API" and updating descriptions related to deployment and security features.

Test Suggestions

• Verify that the new deployment options documentation is correctly rendered and accessible on the website.
• Test the Azure Private Link configuration guide by following the steps to ensure they result in a successful private endpoint setup.
• Check for broken links or missing images in the newly added documentation sections.
• Ensure that the security and data privacy information is accurately reflected and consistent across all relevant documentation pages.

A PR preview is available: Preview URL

@cachafla @validbeck my apologies, I had not changed the title of the PR before requesting review from you — this PR includes the docs for the deployment architecture info we had talked about.

Sorry for the delay, I'll start reviewing.

In general I recommend using "private link connection" whenever we say "VPC connection". A VPC is just the "place" where a deployment. For example, we should say "private link" in this diagram:

A PR preview is available: Preview URL

A PR preview is available: Preview URL

@validbeck thank you for reviewing! I believe I have addressed your comments.

**Virtual Private ValidMind (VPV) — Maybe we want top add this to the variables?

Yup, done! I did not variablify "multi-tenant cloud", as it's not a proper name.

I'm not a fan of the request a demo button. Maybe make that section into a callout instead?**

Done in both places (you had done one already).

For the Azure Steps 1c - e maybe we want some line breaks here?

You'd added some it seems but the spacing is at odds with what's further down, see the "Before" screenshot. I tried spacing out all substeps but the topic just ends up a mess of whitespace. As a compromise, I put the different options you select on their own bullets and then removed some of the spacing again. This puts the topic more in line with the other private link content we have.

Before	After

A PR preview is available: Preview URL

As a compromise, I put the different options you select on their own bullets and then removed some of the spacing again.

Nice, that was going to be my alternative suggestion!

@cachafla I believe I have addressed your comments.

In general I recommend using "private link connection" whenever we say "VPC connection"

Thank you! Changed to "private link" or "private link connection in all the deployment content, for both text and graphics.

A PR preview is available: Preview URL

A PR preview is available: Preview URL

The callout was still quite cosmetically inelegant... so...

A PR preview is available: Preview URL