diff --git a/ml-platform/01_gcp_project/README.md b/ml-platform/01_gcp_project/README.md index 91fbdca18..269576a79 100644 --- a/ml-platform/01_gcp_project/README.md +++ b/ml-platform/01_gcp_project/README.md @@ -1,3 +1,4 @@ + ## Requirements | Name | Version | diff --git a/ml-platform/02_gke/README.md b/ml-platform/02_gke/README.md index 836ffcc86..248d1ee57 100644 --- a/ml-platform/02_gke/README.md +++ b/ml-platform/02_gke/README.md @@ -1,3 +1,4 @@ + ## Requirements | Name | Version | diff --git a/ml-platform/02_gke/modules/cloud-nat/README.md b/ml-platform/02_gke/modules/cloud-nat/README.md index 6952d4e9f..e498d7958 100644 --- a/ml-platform/02_gke/modules/cloud-nat/README.md +++ b/ml-platform/02_gke/modules/cloud-nat/README.md @@ -1,3 +1,4 @@ + # Terraform Google Cloud NAT Module This module handles opinionated Google Cloud Platform Cloud NAT creation and configuration. diff --git a/ml-platform/02_gke/modules/network/README.md b/ml-platform/02_gke/modules/network/README.md index 6de9bdc13..14e1591d8 100644 --- a/ml-platform/02_gke/modules/network/README.md +++ b/ml-platform/02_gke/modules/network/README.md @@ -1,3 +1,4 @@ + ## Requirements | Name | Version | diff --git a/ml-platform/03_configsync/README.md b/ml-platform/03_configsync/README.md index ef777933e..70da6a370 100644 --- a/ml-platform/03_configsync/README.md +++ b/ml-platform/03_configsync/README.md @@ -1,3 +1,4 @@ + ## Requirements | Name | Version | diff --git a/ml-platform/04_setup_clusters/README.md b/ml-platform/04_setup_clusters/README.md index 64f8240df..8e69190ee 100644 --- a/ml-platform/04_setup_clusters/README.md +++ b/ml-platform/04_setup_clusters/README.md @@ -1,3 +1,4 @@ + ### This doc is meant for the platform admins or the group that has admin level permissions on the GKE clusters. The steps mentioned in these docs must be executed by them. ## Prerequisite diff --git a/ml-platform/05_setup_teams/README.md b/ml-platform/05_setup_teams/README.md index e0c90e4d4..70516f1a6 100644 --- a/ml-platform/05_setup_teams/README.md +++ b/ml-platform/05_setup_teams/README.md @@ -1,3 +1,4 @@ + ### This doc is meant for the platform admins or the group that has admin level permissions on the GKE clusters. The steps mentioned in these docs must be executed by them. ## Prerequisite diff --git a/ml-platform/06_operating_teams/README.md b/ml-platform/06_operating_teams/README.md index f550b3c0b..9b5712210 100644 --- a/ml-platform/06_operating_teams/README.md +++ b/ml-platform/06_operating_teams/README.md @@ -1,3 +1,4 @@ + This doc describes how you as an App team member will use the configsync repo to manage your applications scoped to your namespace. We will demonstrate this with an example of installing `ray` in the namespace. Typically, you can install any software or deploy any application in your namespace in the same fashion. diff --git a/ml-platform/README.md b/ml-platform/README.md index 54037e5b2..59e712b18 100644 --- a/ml-platform/README.md +++ b/ml-platform/README.md @@ -1,3 +1,4 @@ + # Reference architecture demonstrating how to build your ML platform on GKE. ## Purpose