Final update for docs before publish

github-community-projects · Jan 24, 2024 · 8d0d419 · 8d0d419
1 parent a898e40
commit 8d0d419
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/images/branch-protection.png b/docs/images/branch-protection.png
diff --git a/docs/using-the-app.md b/docs/using-the-app.md
@@ -10,10 +10,16 @@
 
 ![List of public forks inside the organization](images/public-forks-inside-org.png)
 
-5. Click on the name of the public fork you just created. Click **Create mirror** and give it an unambiguous name, then click **Confirm**. This will create your **private mirror** of the repo. The app syncs commits on the private mirror's default branch to a new branch on the public fork, whose name will match the repository name you enter here. So it's better to be verbose and describe how this fork will be used.
+5. Click on the name of the public fork you just created. Click **Create mirror** and give it an unambiguous name, then click **Confirm**. This will create a **private mirror** of the repo. The app syncs commits on the private mirror's default branch to a new branch on the public fork. The public fork's branch will be named after the private mirror, so the default branch of a private mirror named `silverteam-website` will be synced to a branch named `silverteam-website` on the public fork. So it's a good idea to be verbose in your name and describe how this fork will be used. ICF's workflow supports multiple private mirrors per public fork, to enable different individuals or teams to work on the default branches of their respective mirrors without interefering with each other.
 
 ![Dialog showing creation of new private mriror](images/create-new-mirror.png)
 
+6. As the app creates the private mirror, it also adds some basic branch protection rules to require approvals before merge, but you'll likely want to customize these with additional checks to meet your internal requirements for compliance or IP review. Go to the newly-created mirror's **Settings** page and add or modify the rules under **Branches**.
+
+![Branch protection rules in the private mirror's settings](images/branch-protection.png)
+
+The mirror should now be ready for PRs!
+
 ## PR workflow once a mirror is active
 
 1. Create a pull request against the private mirror repo