docs: review

facebook · Apr 4, 2024 · 6757407 · 6757407
1 parent 369abbb
commit 6757407
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx
@@ -355,6 +355,11 @@ Our goal is that:
 1. When a new pull request is made to `main`, there's an action that ensures the site builds successfully, without actually deploying. This job will be called `test-deploy`.
 2. When a pull request is merged to the `main` branch or someone pushes to the `main` branch directly, it will be built and deployed to GitHub Pages. This job will be called `deploy`.
 
+Here are two approaches to deploying your docs with GitHub Actions. Based on the location of your deployment repository, choose the relevant tab below:
+
+- Source repo and deployment repo are the **same** repository.
+- The deployment repo is a **remote** repository, different from the source. Instructions for this scenario assume [publishing source](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) is the `gh-pages` branch.
+
 ```mdx-code-block
 <Tabs>
 <TabItem value="same" label="Same">