diff --git a/components/CenteredImage.jsx b/components/CenteredImage.jsx new file mode 100644 index 00000000..b2a8ae73 --- /dev/null +++ b/components/CenteredImage.jsx @@ -0,0 +1,18 @@ +import React from "react"; + +/** + * Component for centering an image in the docs + * + * @param {*} props : + * src: image source + * alt: image alternative text + * delegated: any other props (i.e. style for the image) + * @returns a component for uniformally centering images in the doc + */ +export default function CenteredImage({ src, alt, ...delegated }) { + return ( +
+ {alt} +
+ ); +} diff --git a/docs/deployments/firebase.mdx b/docs/deployments/firebase.mdx index 0714906a..3f125d59 100644 --- a/docs/deployments/firebase.mdx +++ b/docs/deployments/firebase.mdx @@ -9,6 +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 CenteredImage from "@site/components/CenteredImage"; 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. @@ -67,14 +68,14 @@ _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 - Firebase project settings 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 - Firebase web credentials @@ -142,7 +143,6 @@ firebase init hosting:github Firebase will update the files `firebase-hosting-pull-request.yml` and `firebase-hosting-merge.yml` inside the `.github/workflows/` directory. Please ensure the "run" step is `npm ci && npm run build:firebase` in both files! ::: - ## Managing Data Honeycomb ships with a CLI script for managing data in Firebase. A local service account must be created in order to use it. @@ -152,7 +152,7 @@ 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/) - Firebase project settings @@ -253,20 +253,14 @@ 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" - -
- Create a study -
+ The study should look like this when you're finished: -Example study + **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 b23c1c35..79bacda6 100644 --- a/docs/further_reading/version_control.mdx +++ b/docs/further_reading/version_control.mdx @@ -9,6 +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 CenteredImage from "@site/components/CenteredImage"; ## Git Overview @@ -16,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. -Git basics + 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. -Example branches diagram + ## 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. -Create a pull request -Add reviewers to a pull request + + ## Best Practices diff --git a/docs/quick_start.mdx b/docs/quick_start.mdx index e5f8b500..a8bb12ea 100644 --- a/docs/quick_start.mdx +++ b/docs/quick_start.mdx @@ -15,6 +15,8 @@ import template1 from "./assets/template_1.png"; import workflowPermissions from "./assets/workflow-permissions.png"; import powershellAdmin from "./assets/powershell_admin.png"; +import CenteredImage from "@site/components/CenteredImage"; + ## Creating Your Task Repository The Honeycomb repository is a template and serves as the starting point for all tasks. Creating your repository from the template starts your project with the same directory structure and files as an existing repository. @@ -22,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`. - Use this template + 3. Enter the owner, name, and description of your repository and click on `Create repository from template`. - Create the repository + :::note We recommend creating a public repository and leaving `Include all branches` unchecked @@ -36,7 +38,10 @@ The Honeycomb repository is a template and serves as the starting point for all _`Settings -> Actions -> General -> Workflow permissions`_ - GitHub workflow permissions settings + _Additional details about template repositories can be found on the [Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)._ @@ -47,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 - GitHub clone repo button + 3. Open a terminal and navigate to where you want the cloned directory @@ -108,7 +113,7 @@ See [Prerequisites](prerequisites) for more information about these programs. 1. Run Powershell as an admin from the start menu - Powershell admin launcher + 2. Navigate to the root directory of your cloned repository 3. Paste the following command and follow the prompts to install the listed programs: