Merge pull request #146 from mcnuttandrew/netlify-deploy

Document netlify deploy process

Author: JackWilb

docs/data-and-deployment/deploying-to-static-website.md

@@ -7,13 +7,14 @@ sidebar_position: 2
 import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
 <StructuredLinks
-    referenceLinks={[
-        {name: "GitHub Pages", url: "https://docs.github.com/en/pages/quickstart"},
-        {name: "GitHub Custom Domain", url: "https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site"}
-    ]}
+referenceLinks={[
+{name: "GitHub Pages", url: "https://docs.github.com/en/pages/quickstart"},
+{name: "GitHub Custom Domain", url: "https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site"}
+]}
 />
 
 ## Deploying using GitHub
+
 Deploying your study should be relatively simple. We include a GitHub action that will build your study and deploy it to GitHub pages. The only item that the user must adjust is in the `.env` file in the root of the repository. At the top of this file, you should see `VITE_BASE_PATH="/study/"`. Change "/study/" to `"/<repo-name>/"`.
 
 After this, you'll need to make sure that your Github repository has workflow actions enabled. Navigate to the actions tab in your repository as shown below.
@@ -43,3 +44,31 @@ Click 'Save' once you have made the switch. After a short period of time, your r
 :::info
 If you would like to enable admin sign ins when you deploy your static website, you will have to make sure that Firebase has your domain name set as an authorized domain. Please see [here](../authentication-authorization/adding-removing-ui/#adding-authorized-domains) to add your custom domain.
 :::
+
+## Deploying using Netlify
+
+Similarly deploying your study to Netlify is relatively straightforward. First, modify the VITE_BASE_PATH in your .env to be
+
+```
+VITE_BASE_PATH="/"
+```
+
+Then create a new file called `public/_redirects`, the contents of the file should be
+
+```
+/*    /index.html   200
+```
+
+Next, navigate to netlify. This will likely require you to sign in or to make an account. From the home page, create a new project using
+
+![Demo](./img/netlify_steps/netlify_1.png)
+
+Then, on the next page, select Github. This will require you to authorize netlify as a GitHub app. This will then bring up a list of repos
+
+![Demo](./img/netlify_steps/netlify_2.png)
+
+Search for the appropriate repo and then select it. This will bring up a configuration screen for the new netlify project. You should enter a project name, which will determine the url (e.g., YOUR_PROJECT.netlify.app if your project name is YOUR_PROJECT). Scroll to the bottom of the screen and click "Deploy YOUR PROJECT NAME".
+
+The first build will take a bit, but once it runs, your experiment should be ready!
+
+If you are using netlify as a secondary venue for anonymization purposes, you can specify which branch netlify will use to deploy from. For instance a branch called `for-review' might remove all personnel and affiliation information.

docs/data-and-deployment/img/netlify_steps/netlify_1.png

@@ -3,12 +3,12 @@
 import StructuredLinks from '@site/src/components/StructuredLinks/StructuredLinks.tsx';
 
 <StructuredLinks
-    referenceLinks={[
-        {name: "Snapshots", url: "../../analysis/data-management/#snapshots"}
-    ]}
+referenceLinks={[
+{name: "Snapshots", url: "../../analysis/data-management/#snapshots"}
+]}
 />
 
-A reVISit study will go through multiple stages over its lifetime. It'll first start as a local study that is iteratively refined until the study is fully built, it will then be deployed and tested, it will be send out to participants for data to be collected, and finally the study will be disseminated to reviewers. 
+A reVISit study will go through multiple stages over its lifetime. It'll first start as a local study that is iteratively refined until the study is fully built, it will then be deployed and tested, it will be send out to participants for data to be collected, and finally the study will be disseminated to reviewers.
 
 ## Revisit Modes
 
@@ -53,3 +53,5 @@ When disseminating your study to reviewers and the wider public, you should:
 - Disable data collection
 - Enable the study navigator
 - Make the analytics interface publicly accessible
+
+If your are submitting to a venue that requires anonymization, such as ACM SIGCHI, consider creating a second deployment. If your primary deployment is on GitHub, consider adding a secondary one on [netlify](/docs/data-and-deployment/deploying-to-static-website/#deploying-using-netlify).