From caed60d34cd69c9e552621b84c9e791dbe20d11d Mon Sep 17 00:00:00 2001
From: hari-selvarajan_data <hari.selvarajan@databricks.com>
Date: Tue, 24 Sep 2024 17:38:22 +0100
Subject: [PATCH 1/4] collection doc update

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 5589fbe36d..530c1999c9 100644
--- a/README.md
+++ b/README.md
@@ -124,6 +124,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
   * [`revert-cluster-remap` command](#revert-cluster-remap-command)
   * [`upload` command](#upload-command)
   * [`download` command](#download-command)
+  * [`join-collection` command](#join-collection command)
 * [Common Challenges and the Solutions](#common-challenges-and-the-solutions)
     * [Network Connectivity Issues](#network-connectivity-issues)
     * [Insufficient Privileges](#insufficient-privileges)
@@ -1786,6 +1787,38 @@ $ databricks labs ucx download --file <file_path> --run-as-collection True
 Download a csv file from a single workspace (`--run-as-collection False`) or a collection of workspaces
 (`--run-as-collection True`). This command is especially useful when downloading the same file from multiple workspaces.
 
+## `join-collection` command
+
+```text
+$ databricks labs ucx join-collection --workspace-ids <comma seperate list of workspace ids> --profile <account-profile>
+```
+
+`join-collection` command joins 2 or more workspaces into a collection. This helps in running supported cli commands as a collection
+`join-collection` command updates config.yml file on each workspace ucx installation with installed_workspace_ids attribute.
+In order to run `join-collectioon` command a user should be:
+ - Account admin on the Databricks account
+ - Workspace admin on all the workspaces to be joined as a collection) or a collection of workspaces
+ - should have installed UCX on the workspace
+The `join-collection` command will fail and throw an error msg if the above conditions are not met.
+
+## collection eligible command
+
+Once `join-collection` command run, it allows user to run multiple cli commands as a collection. The following cli commands
+are eligible to be run as a collection. User can run the below commands as collection by passing an additional flag `--run-as-collection=True`
+- `ensure-assessment-run`
+- `create-table-mapping`
+- `principal-prefix-access`
+- `migrate-credentials`
+- `create-uber-principal`
+- `create-missing-principals`
+- `validate-external-location`
+- `migrate-locations`
+- `create-catalog-schemas`
+- `migrate-tables`
+- `migrate-acls`
+- `migrate-dbsql-dashboards`
+- `validate-group-membership`
+
 # Common Challenges and the Solutions
 Users might encounter some challenges while installing and executing UCX. Please find the listing of some common challenges and the solutions below.
 

From 7977f826aec80efe2e1c01f73b41a0daf566f705 Mon Sep 17 00:00:00 2001
From: hari-selvarajan_data <hari.selvarajan@databricks.com>
Date: Tue, 24 Sep 2024 17:45:08 +0100
Subject: [PATCH 2/4] collection doc update

---
 README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/README.md b/README.md
index 530c1999c9..79d83d6ac1 100644
--- a/README.md
+++ b/README.md
@@ -125,6 +125,7 @@ See [contributing instructions](CONTRIBUTING.md) to help improve this project.
   * [`upload` command](#upload-command)
   * [`download` command](#download-command)
   * [`join-collection` command](#join-collection command)
+  * [collection eligible command](#collection-eligible-command)
 * [Common Challenges and the Solutions](#common-challenges-and-the-solutions)
     * [Network Connectivity Issues](#network-connectivity-issues)
     * [Insufficient Privileges](#insufficient-privileges)

From 07c78328ea5690d3311266401cf55a83382dc96b Mon Sep 17 00:00:00 2001
From: hari-selvarajan_data <hari.selvarajan@databricks.com>
Date: Tue, 24 Sep 2024 17:48:28 +0100
Subject: [PATCH 3/4] doc update

---
 README.md | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 79d83d6ac1..27a0494de7 100644
--- a/README.md
+++ b/README.md
@@ -1796,15 +1796,15 @@ $ databricks labs ucx join-collection --workspace-ids <comma seperate list of wo
 
 `join-collection` command joins 2 or more workspaces into a collection. This helps in running supported cli commands as a collection
 `join-collection` command updates config.yml file on each workspace ucx installation with installed_workspace_ids attribute.
-In order to run `join-collectioon` command a user should be:
- - Account admin on the Databricks account
- - Workspace admin on all the workspaces to be joined as a collection) or a collection of workspaces
- - should have installed UCX on the workspace
+In order to run `join-collectioon` command a user should:
+ - be an Account admin on the Databricks account
+ - be a Workspace admin on all the workspaces to be joined as a collection) or a collection of workspaces
+ - have installed UCX on the workspace
 The `join-collection` command will fail and throw an error msg if the above conditions are not met.
 
 ## collection eligible command
 
-Once `join-collection` command run, it allows user to run multiple cli commands as a collection. The following cli commands
+Once `join-collection` command is run, it allows user to run multiple cli commands as a collection. The following cli commands
 are eligible to be run as a collection. User can run the below commands as collection by passing an additional flag `--run-as-collection=True`
 - `ensure-assessment-run`
 - `create-table-mapping`

From f33cfcd7fb3d3a39fb82b9554e507f4176d0ad01 Mon Sep 17 00:00:00 2001
From: hari-selvarajan_data <hari.selvarajan@databricks.com>
Date: Tue, 24 Sep 2024 17:50:36 +0100
Subject: [PATCH 4/4] doc update

---
 README.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/README.md b/README.md
index 27a0494de7..f7d02212b4 100644
--- a/README.md
+++ b/README.md
@@ -1819,6 +1819,8 @@ are eligible to be run as a collection. User can run the below commands as colle
 - `migrate-acls`
 - `migrate-dbsql-dashboards`
 - `validate-group-membership`
+Ex: `databricks labs ucx ensure-assessment-run --run-as-collection=True`
+
 
 # Common Challenges and the Solutions
 Users might encounter some challenges while installing and executing UCX. Please find the listing of some common challenges and the solutions below.