updated README.md docs, main.tf, and CONTRIBUTING.md

Author: dcallao

CONTRIBUTING.md

@@ -9,13 +9,8 @@ Contributors to this project must abide by the [Contributor Covenant Code of Con
 The project has the following folders and files:
 
 - /: root folder.
-- /docs: Examples for using this module.
 - /examples: Examples for using this module.
-- /files: Static files referenced but not executed by Terraform.
-- /helpers: Helper scripts NOT called by Terraform.
 - /modules: Inline local modules called by this module.
-- /scripts: Scripts for specific tasks on module.
-- /templates: Template files used to be execute by data sources.
 - /main.tf: Main file for this module, contains all the resources to operate the module.
 - /variables.tf: All the variables necessary for run the module.
 - /output.tf: The outputs generate from the module.
@@ -25,6 +20,20 @@ The project has the following folders and files:
 - /CODE_OF_CONDUCT.md: Code of Conduct file.
 - /CONTRIBUTING.md: This file.
 
+## Adding a new module
+
+To add a new module, fork this repo then add your module under [./modules](./modules/) folder. Please visit our [Terraform Module Development Standards guide](https://github.com/equinix-labs/equinix-labs/blob/main/terraform-module-standards.md) for more info on module development best practices.
+
 ## Issues and Change Requests
 
-Please submit change requests and / or features via [Issues](https://github.com/equinix-labs/equinix-labs/issues).
+Please submit change requests and / or features via [Issues](https://github.com/equinix-labs/terraform-equinix-labs/issues).
+
+## Submitting Pull Requests
+
+Before starting any work or sending us a pull request, please ensure that:
+
+- Your working branch is up-to-date with the latest source on the main branch.
+- Check issues and pull requests (open/merged) to make sure someone else hasn't already addressed that issue.
+- You open an issue to discuss your proposal.
+
+To learn how to send us a pull request, please see [Contributing to Projects](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) in the GitHub Docs.

README.md

@@ -4,13 +4,11 @@
 [![run-pre-commit-hooks](https://github.com/equinix-labs/terraform-equinix-labs/actions/workflows/pre-commit.yaml/badge.svg)](https://github.com/equinix-labs/terraform-equinix-labs/actions/workflows/pre-commit.yaml)
 [![generate-terraform-docs](https://github.com/equinix-labs/terraform-equinix-labs/actions/workflows/documentation.yaml/badge.svg)](https://github.com/equinix-labs/terraform-equinix-labs/actions/workflows/documentation.yaml)
 
-This repository contains a collection of Terraform modules to help automate the deployment and management of both baremetal and [Kubernetes (EKS-A)](https://github.com/equinix-labs/terraform-equinix-metal-eks-anywhere) environments running on [Equinix Metal](https://deploy.equinix.com/).
-
-Visit [EKS-A Baremetal on Equinix Metal](https://github.com/equinix-labs/terraform-equinix-metal-eks-anywhere) for more info on EKS-A on baremetal.
+This repository contains a collection of Terraform modules to help automate the deployment and management of either bare metal nodes or a kubernetes cluster environment running on [Equinix Metal](https://deploy.equinix.com/).
 
 ## Usage
 
-This project is intended to be used as a Terraform module. It may also be forked, cloned, or downloaded and modified as needed as the base in your integrations and deployments. Module [invite-from-csv](./modules/invite-from-csv/) may be enabled mutually exclusively.
+This project is intended to be used as a Terraform module. It may also be forked, cloned, or downloaded and modified as needed as the base in your integrations and deployments.
 
 Prerequesites:
 
@@ -20,7 +18,12 @@ Prerequesites:
 
 ## Examples
 
-Check out [examples](./examples/) directory for examples on how to utilize this module.
+This project may be deployed into new project(s) or existing project(s). Check out sample deployments in the [examples](./examples/) directory described as follows:
+
+| Name | Description |
+|------|---------|
+| [eksa-setup](./examples/eksa-setup/) | Deploys a AWS EKS-A cluster into new projects provisioned for each user described in users.csv  |
+| [metal-setup](./examples/metal-setup/) | Deploys a cluster or bare nodes into new projects provisioned for each user described in users.csv  |
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements
@@ -68,3 +71,10 @@ No resources.
 | <a name="output_deploy_metal_outputs"></a> [deploy\_metal\_outputs](#output\_deploy\_metal\_outputs) | Outputs of the Deploy Metal module |
 | <a name="output_project_setup_outputs"></a> [project\_setup\_outputs](#output\_project\_setup\_outputs) | Outputs of the Project Setup module |
 <!-- END_TF_DOCS -->
+## Contributing
+
+If you would like to contribute to this module, see [CONTRIBUTING](CONTRIBUTING.md) page for more info.
+
+## License
+
+Apache License, Version 2.0. See [LICENSE](LICENSE).

examples/eksa-setup/README.md

@@ -1,6 +1,6 @@
 # Terraform Equinix Labs EKSA Setup Example
 
-This is an example of how to utilize the root module to deploy the [eksa](../../modules/eksa/) module.
+This is an example of how to utilize the root module to deploy the [invite-from-csv](https://github.com/equinix-labs/terraform-equinix-labs/tree/main/modules/invite-from-csv) module and the [eksa](https://github.com/equinix-labs/terraform-equinix-labs/tree/main/modules/eksa) module. In this example, each user identified in the `users.csv` file (see users.csv.example) will have a project provisioned and an invitation sent by email to join that project. Kubernetes will then be provisioned into each user's project with the configurations set within the [variables.tf](./variables.tf) file.
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements

examples/metal-setup/README.md

@@ -1,6 +1,6 @@
 # Terraform Equinix Labs Metal Setup Example
 
-This is an example of how to utilize the root module to deploy the [metal](../../modules/metal/) module.
+This is an example of how to utilize the root module to deploy the [invite-from-csv](https://github.com/equinix-labs/terraform-equinix-labs/tree/main/modules/invite-from-csv) module and the [metal](https://github.com/equinix-labs/terraform-equinix-labs/tree/main/modules/metal) module. In this example, each user identified in the `users.csv` file (see users.csv.example) will have a project provisioned and an invitation sent by email to join that project. Kubernetes will then be provisioned into each user's project with the configurations set within the [variables.tf](./variables.tf) file.
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements

main.tf

@@ -3,14 +3,22 @@ terraform {
   required_version = ">= 1.3"
 }
 
+# ---------------------------------------------------------------------------------------------------------------------
+# Project Setup
+# ---------------------------------------------------------------------------------------------------------------------
+
 # Setup Project for deploying metal or EKSA
 module "project_setup" {
   count                 = var.enable_workshop_setup ? 1 : 0
   source                = "./modules/invite-from-csv"
   metal_organization_id = var.metal_organization_id
 }
 
-# Deploy the metal module if platform of choice is metal
+# ---------------------------------------------------------------------------------------------------------------------
+# Platforms
+# ---------------------------------------------------------------------------------------------------------------------
+
+# Deploy the metal module if platform of choice is Metal
 module "deploy_metal" {
   count  = var.enable_metal ? 1 : 0
   source = "./modules/metal"
@@ -19,7 +27,7 @@ module "deploy_metal" {
   module_config  = var.metal_config
 }
 
-# Deploy the eksa module if platform of choice is eksa
+# Deploy the eksa module if platform of choice is EKSA
 module "deploy_eksa" {
   count  = var.enable_eksa ? 1 : 0
   source = "./modules/eksa"

modules/eksa/main.tf

@@ -14,5 +14,4 @@ module "eksa" {
   cluster_name        = var.module_config.cluster_name
   cp_device_count     = var.module_config.cp_device_count
   worker_device_count = var.module_config.worker_device_count
-
 }

modules/invite-from-csv/README.md

@@ -1,6 +1,6 @@
 # Terraform Equinix Labs Invite from CSV Module
 
-This module will loop over every user provided in the users.csv file and call the [collaborator-project](../collaborator-project/) module to create a project.
+This module reads a given filename `users.csv`, identifies each user entry in the file, then calls [collaborator-project](../collaborator-project/) module to create a project for them.
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements

modules/metal/README.md

@@ -1,6 +1,6 @@
 # Terraform Equinix Labs Metal Module
 
-This module deploys bare metal machines as a cluster.
+This module provisions a cluster of bare metal machines, VLAN, gateway, and an SSH key for users to SSH into the provisioned bare metal machines.
 
 <!-- BEGIN_TF_DOCS -->
 ## Requirements