Update adding library documentation

danskernesdigitalebibliotek · Dec 6, 2024 · bc20601 · bc20601
1 parent 20cff74
commit bc20601
Showing 1 changed file with 21 additions and 9 deletions.
diff --git a/docs/runbooks/add-library-site-to-platform.md b/docs/runbooks/add-library-site-to-platform.md
@@ -85,7 +85,7 @@ The field `plan` defaults to `standard`.
 
 Now you are ready to sync the site state.
 
-### Synchronize site state for all sites
+### Synchronize site state for site
 
 You have made a single additive change to the `sites.yaml` file. It is
 important to ensure that your branch is otherwise up-to-date with `main`,
@@ -101,7 +101,13 @@ Prerequisites:
   the Lagoon UI, on the Settings page)
 
 From within `dplsh` run the `sites:sync` task to sync the site state in
-sites.yaml, creating your new site
+sites.yaml, creating your new site:
+
+```sh
+task site:full-sync
+```
+
+Or to sync multiple sites.
 
 ```sh
 task sites:sync
@@ -111,15 +117,21 @@ You may be prompted to confirm Terraform plan execution and approve other
 critical steps. Read and consider these messages carefully and ensure you are
 not needlessly changing other sites.
 
+Be aware that while `site:full-sync` works with a single site in
+Lagoon, Terraform always works on all sites, so if you see another
+site than the one you're adding in the Terraform plan, abort
+immediately.
+
 The synchronization process:
 
-* ensures a Github repo is provisioned for each site
-* creates a Lagoon configuration for each site and pushes it to the relevant
-  branches in the repo (for example, sites with `plan: "webmaster"` also get
-  a `moduletest` branch for testing custom Drupal modules)
-* ensures a Lagoon project is created for each site
-* configures Lagoon to track and deploy all the relevant branches for each site
-  as environments
+* ensures a Github repo is provisioned for the site
+* creates a Lagoon configuration for the site and pushes it to the
+  relevant branches in the repo (for example, sites with `plan:
+  "webmaster"` also get a `moduletest` branch for testing custom
+  Drupal modules)
+* ensures a Lagoon project is created for the site
+* configures Lagoon to track and deploy all the relevant branches for
+  the site as environments
 
 If no other changes have been made to `sites.yaml`, the result is that your new
 site is created and deployed to all relevant environments.