chore: Refine site repo migration docs

cloud-gov · Oct 17, 2023 · 5fb6f8e · 5fb6f8e
1 parent 90bc193
commit 5fb6f8e
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/OPERATIONS.md b/OPERATIONS.md
@@ -20,5 +20,15 @@ Requirements:
 Example:
 
 ```bash
-$ cf run-task pages-<env> "yarn migrate-site-repo 1 [email protected] agency-org site-repo" --name site-1-migrate
+## Running the site repo migration ##
+# Task arguments:
+#   --command Required: Runs migration command with args
+#      ie: yarn migrate-site-repo <siteId> <email> <owner> <repository>
+#   [--name] Optional: Name to give the task (generated if omitted)
+
+## Example migration
+$ cf run-task pages-<env> --command "yarn migrate-site-repo 1 [email protected] agency-org site-repo" --name site-1-migrate
+
+## See the migration output
+$ cf logs --recent pages-<env>
 ```