diff --git a/docs/assets/center_img.jsx b/docs/assets/CenteredImage.jsx similarity index 93% rename from docs/assets/center_img.jsx rename to docs/assets/CenteredImage.jsx index 8c5610db..4f12cbe4 100644 --- a/docs/assets/center_img.jsx +++ b/docs/assets/CenteredImage.jsx @@ -9,8 +9,7 @@ import React from "react"; * imgStyle: object, any image styles (props can be passed in as: `imgStyle={{ maxHeight: "600px", border: "solid" }}`) * @returns a component for uniformally centering images in the doc */ - -export default function CenterImg(props) { +export default function CenteredImage(props) { let imgStyleString; if (props.imgStyle != undefined && Object.keys(props.imgStyle).length === 0) { imgStyleString = {}; diff --git a/docs/deployments/firebase.mdx b/docs/deployments/firebase.mdx index 29825821..34828dc8 100644 --- a/docs/deployments/firebase.mdx +++ b/docs/deployments/firebase.mdx @@ -9,7 +9,7 @@ import firebaseConsoleSettings from "../assets/firebase/firebase-console-setting import firebaseWebCredentials from "../assets/firebase/firebase-web-credentials.png"; import firestoreCreateStudy from "../assets/firebase/firestore-create-study.png"; import firestoreExampleStudy from "../assets/firebase/firestore-example-study.png"; -import CenterImg from "../assets/center_img.jsx"; +import CenteredImage from "../assets/CenteredImage.jsx"; Honeycomb comes with methods and configurations to deploy tasks with [Firebase](https://firebase.google.com/). These tools make it possible to reach a wider audience by hosting your task online. @@ -68,14 +68,17 @@ _A `command not found` error usually indicates firebase-tools has not been insta 1. Return to your project on the [Firebase console](https://console.firebase.google.com/) 2. Navigate to your project setting - 3. Scroll down and copy the auto-generated values from the Firebase console to the corresponding variables in the `.env.firebase` file in the `env` folder of your Honeycomb task repo - +

@@ -149,7 +152,10 @@ Honeycomb ships with a CLI script for managing data in Firebase. A local service Service accounts are accounts that are not attached to a human user. They authorize access to a Firebase project without someone physically logging in online. We use a service account to give the download script access to the Firestore database automatically. 1. Return to the project settings your project on the [Firebase console](https://console.firebase.google.com/) - + 2. Click on the "Service accounts" tab 3. Near the bottom, click "Generate new Private key" and "Generate Key" @@ -247,7 +253,7 @@ Firestore rules define every valid path for data in your project. Attempting to 5. Click "Add Field". 6. Enter `registered_participants` as the field name, and set the type "array" 7. Add the id of each study participant to the array as type "string" - + **Additional studies are created as documents inside the `registered_studies` collection** diff --git a/docs/further_reading/version_control.mdx b/docs/further_reading/version_control.mdx index b6208b2f..33db1d9b 100644 --- a/docs/further_reading/version_control.mdx +++ b/docs/further_reading/version_control.mdx @@ -9,7 +9,7 @@ import gitBasics from "../assets/further_reading/git_basics.png"; import gitBranch from "../assets/further_reading/git_branch.png"; import createPR from "../assets/further_reading/create_pull_request.png"; import addReviewers from "../assets/further_reading/add_reviewers.png"; -import CenterImg from "../assets/center_img.jsx"; +import CenteredImage from "../assets/CenteredImage.jsx"; ## Git Overview @@ -17,18 +17,18 @@ Git is a version control system that enables you to track changes to files. With Nearly all operations that are performed by Git are in your local computing environment, with the exception of a few used to synchronize with the GitHub remote host. Some of the most common git operations are depicted below. - + If you would like to make any changes to current repository, it is always good to start with creating a feature branch, where you can save all the changes. - + ## Create a Pull Request Pull requests are useful before you merge your branch with the main branch. You can request a review from your colleagues and check for any conflicts with the main branch. After you pushed all the changes to your branch, you can go to the original GitHub repository and click on the pull request. - - + + ## Best Practices diff --git a/docs/quick_start.mdx b/docs/quick_start.mdx index 264225dd..4c36e801 100644 --- a/docs/quick_start.mdx +++ b/docs/quick_start.mdx @@ -15,7 +15,7 @@ import template1 from "./assets/template_1.png"; import workflowPermissions from "./assets/workflow-permissions.png"; import powershellAdmin from "./assets/powershell_admin.png"; -import CenterImg from "./assets/center_img.jsx"; +import CenteredImage from "./assets/CenteredImage.jsx"; ## Creating Your Task Repository @@ -24,11 +24,11 @@ The Honeycomb repository is a template and serves as the starting point for all 1. Go to the [Honeycomb repository](https://github.com/brown-ccv/honeycomb) 2. Click on `Use this template` and select `Create a new repository`. - + 3. Enter the owner, name, and description of your repository and click on `Create repository from template`. - + :::note We recommend creating a public repository and leaving `Include all branches` unchecked @@ -38,7 +38,7 @@ The Honeycomb repository is a template and serves as the starting point for all _`Settings -> Actions -> General -> Workflow permissions`_ - @@ -52,7 +52,7 @@ With the repository now setup it can be cloned onto your computer. 1. Navigate to the repository on [GitHub](https://github.com). 2. Click the `Code` button and copy the URL - + 3. Open a terminal and navigate to where you want the cloned directory @@ -113,7 +113,7 @@ See [Prerequisites](prerequisites) for more information about these programs. 1. Run Powershell as an admin from the start menu - + 2. Navigate to the root directory of your cloned repository 3. Paste the following command and follow the prompts to install the listed programs: