firebase documentation#170
Merged
Merged
Conversation
Coverage Report
File CoverageNo changed files found. |
|
…nto doc/firebase-new
…nto doc/firebase-new
Contributor
Author
|
04/27/2026 schema update:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds initial Firebase/Firestore documentation to the cellPACK client repo to make the database schema and client usage easier to understand (per #105).
Changes:
- Link Firebase documentation from the main README.
- Add a Firebase overview section to
CONTRIBUTING.md(collections used + access notes). - Introduce
FIREBASE_SCHEMA.mddescribing Firestore collections and retention/cleanup policies.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| README.md | Adds a “cellPACK Database” section linking to the new Firebase docs. |
| CONTRIBUTING.md | Adds “Firebase Overview”, collection access summary, and access guidance. |
| FIREBASE_SCHEMA.md | New schema document describing Firestore collections, fields, and cleanup policies. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
meganrm
approved these changes
Apr 28, 2026
ascibisz
reviewed
Apr 29, 2026
| * GET /logs?logStreamName={name} | ||
| * GET /packing-status?jobId={id} | ||
| * **Batch**: A call to POST /submit-packing launches a new batch job to run. A call to GET /packing-status will return the status of the specified batch job. Once the job is completed, the path to the results file(s) will be added to the results table of the cellPACK Firebase database. | ||
| * **Batch**: A call to POST /submit-packing launches a new batch job to run. A call to GET /packing-status will return the status of the specified batch job. Once the job is completed, the path to the results file(s) is written to the job's `job_status` entry in the cellPACK Firebase database. |
Contributor
There was a problem hiding this comment.
We aren't using **Batch** anymore, we should change this to **ECS**
We also don't use the GET /packing-status endpoint anymore, so we can probably remove all references to that
ascibisz
reviewed
Apr 29, 2026
| * **Batch**: A call to POST /submit-packing launches a new batch job to run. A call to GET /packing-status will return the status of the specified batch job. Once the job is completed, the path to the results file(s) is written to the job's `job_status` entry in the cellPACK Firebase database. | ||
| * **S3**: Result files from the AWS Batch job are written to the `cellpack-demo` S3 bucket. | ||
| * **ECR**: Docker image built from the [cellPACK github repo](https://github.com/mesoscope/cellpack) is published to the `cellpack-private` ECR repository. That image defines the container specificationsin which the batch job will run. | ||
| * **CloudWatch**: Logs from each AWS Batch job are written to CloudWatch. These logs can be accessed via the GET /logs endpoint. |
Contributor
There was a problem hiding this comment.
We actually have several references to Batch here that are out of date, now might be the time to remove all of those?
We do still have the concept of "jobs" for each packing in ECS, so we can probalby replace "AWS Batch job" with "AWS packing job" in most places. I think this cloudwatch line can be removed all together, we don't post logs there anymore
ascibisz
approved these changes
Apr 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
What is the problem this work solves, including
closes #105
we've been wanting to document our Firebase schema for a while, this pr introduces the first version.
Solution
What I/we did to solve this problem
Type of change
Please delete options that are not relevant.