Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Documentation for PostgreSQL #57

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

williams-jack
Copy link
Collaborator

Feature/Problem Description

The documentation for Orca has not been updated since replacing Redis as the queue DB with Postgres. Not only should this change be reflected, but items such as protocol diagrams should also be created and added in order to better illustrate the end-to-end workflow of the entire system.

Solution (Changes Made)

  • Data definitions update to reflect most recent changes -- especially the GradingJob definition which no longer relies on Redis.
  • End-to-end Protocol Diagrams to explain the system.
  • Queue documentation to explain the relationship between Reservations, Jobs, and Submitters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant