- Update README with link to architecture and design section

- Restructure design doc folders - Link the existing sequence diagram in readme Partially fixes vmware-tanzu#238 Signed-off-by: Shailesh Pant <7968042+pshail@users.noreply.github.com>
pshail · Feb 21, 2022 · 268b43c · 268b43c
1 parent fb51a6d
commit 268b43c
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -49,6 +49,16 @@ __BYOH__ is a Cluster API Infrastructure Provider for already-provisioned hosts
 ## Getting Started
 Check out the [getting_started](https://github.com/vmware-tanzu/cluster-api-provider-bringyourownhost/blob/main/docs/getting_started.md) guide for launching a BYOH workload cluster
 
+## Architecture and Design
+[diag-base-link]: docs/design/images
+
+#### Create a BYOH Cluster
+This sequence diagram shows how a BYOH cluster can be created using an existing Management Cluster by
+- Registering a host via host-agent on to an existing management cluster which should have BYOH provider enabled
+- Creating a BYOH cluster post successful host registration in the capacity pool
+
+![create-byoh-cluster]([diag-base-link]/sequence-diagrams/create-byoh-cluster.png)
+
 ## Community, discussion, contribution, and support
 
 The BringYourOwnHost provider is developed in the open, and is constantly being improved by our users, contributors, and maintainers.

diff --git a/docs/diagrams/create-byoh-cluster.png → ...sequence-diagrams/create-byoh-cluster.png b/docs/diagrams/create-byoh-cluster.png → ...sequence-diagrams/create-byoh-cluster.png
diff --git a/docs/diagrams/create-byoh-cluster.puml → docs/design/umls/create-byoh-cluster.puml b/docs/diagrams/create-byoh-cluster.puml → docs/design/umls/create-byoh-cluster.puml