feat: moved the management-vpc and workload-vpc submodule from th…

…e `submodules` directory to the `modules` directory to confirm with Hashicorp practises. See updated usage blocks on how to consume. (#694)

README.md

@@ -22,6 +22,9 @@ This module creates the following IBM Cloud® Virtual Private Cloud (VPC) net
 <!-- BEGIN OVERVIEW HOOK -->
 ## Overview
 * [terraform-ibm-landing-zone-vpc](#terraform-ibm-landing-zone-vpc)
+* [Submodules](./modules)
+    * [management-vpc](./modules/management-vpc)
+    * [workload-vpc](./modules/workload-vpc)
 * [Examples](./examples)
     * [Basic Example](./examples/basic)
     * [Default Example](./examples/default)
@@ -38,7 +41,7 @@ This module creates the following IBM Cloud&reg; Virtual Private Cloud (VPC) net
 
 ### Presets
 
-In addition to this root module, this repository provides two submodules that call the root module with presets and defaults that are aligned with the general [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) management and workload VPC topologies. See the [landing-zone-submodules](/landing-zone-submodule/) for details.
+In addition to this root module, this repository provides two submodules that call the root module with presets and defaults that are aligned with the general [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-about) management and workload VPC topologies. See the [modules](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/tree/main/modules) for details.
 
 ### Usage
 ```terraform

examples/landing_zone/README.md

@@ -1,6 +1,6 @@
 # Landing Zone example
 
-This example demonstrates how to use the management and workload VPC [modules](../../landing-zone-submodule/) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
+This example demonstrates how to use the management and workload VPC [modules](https://github.com/terraform-ibm-modules/terraform-ibm-landing-zone-vpc/tree/main/modules) to create a network VPC topology that is aligned with the network segregation key principles of the IBM Cloud [Framework for Financial Services](https://cloud.ibm.com/docs/framework-financial-services?topic=framework-financial-services-vpc-architecture-connectivity-overview).
 
 The example shows how to use the base modules to create the following topology:
 - A management VPC

examples/landing_zone/main.tf

@@ -33,7 +33,7 @@ module "cos_bucket" {
 #############################################################################
 
 module "workload_vpc" {
-  source                                 = "../../landing-zone-submodule/workload-vpc/"
+  source                                 = "../../modules/workload-vpc/"
   resource_group_id                      = module.resource_group.resource_group_id
   region                                 = var.region
   prefix                                 = "${var.prefix}-workload"
@@ -48,7 +48,7 @@ module "workload_vpc" {
 
 
 module "management_vpc" {
-  source               = "../../landing-zone-submodule/management-vpc/"
+  source               = "../../modules/management-vpc/"
   resource_group_id    = module.resource_group.resource_group_id
   region               = var.region
   prefix               = "${var.prefix}-management"

landing-zone-submodule/management-vpc/README.md → modules/management-vpc/README.md

@@ -6,6 +6,17 @@ You can use this submodule when you need more modularity to create your topology
 
 See the [Landing Zone example](../../examples/landing_zone/) for runnable code.
 
+### Usage
+```terraform
+module management_vpc {
+  source              = "terraform-ibm-modules/landing-zone-vpc/ibm//modules/management-vpc"
+  version             = "X.X.X" # replace X.X.X with a release version to lock into an exact release
+  name                = "management"
+  region              = "us-south"
+  prefix              = "management-vpc"
+}
+```
+
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ### Requirements
 

landing-zone-submodule/workload-vpc/README.md → modules/workload-vpc/README.md

@@ -6,6 +6,16 @@ You can use this submodule when you need more modularity to create your topology
 
 See the [Landing Zone example](../../examples/landing_zone/) for runnable code.
 
+### Usage
+```terraform
+module workload_vpc {
+  source              = "terraform-ibm-modules/landing-zone-vpc/ibm//modules/workload-vpc"
+  version             = "X.X.X" # replace X.X.X with a release version to lock into an exact release
+  name                = "workload"
+  region              = "us-south"
+  prefix              = "workload-vpc"
+}
+```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 ### Requirements