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

Add explanatory docs on catalog database #713

Merged
merged 5 commits into from
Apr 10, 2024

Conversation

danielballan
Copy link
Member

Goals:

docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
docs/source/explanations/catalog.md Show resolved Hide resolved
docs/source/explanations/catalog.md Outdated Show resolved Hide resolved
Copy link
Contributor

@dylanmcreynolds dylanmcreynolds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the ER Diagram that's currently in architecture.md be moved into here?

Copy link
Contributor

@dylanmcreynolds dylanmcreynolds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Approved, though I left a comment about moving the ER Diagram from architecture here.

@danielballan
Copy link
Member Author

Good note. I moved the diagram (replacing it with a link in its original location). I added a one-line description of each table below the diagram. It all fits on one screen. Seems good to have.

image

@danielballan
Copy link
Member Author

(CI failure on Python 3.11 is #715, unrelated.)

@genematx genematx merged commit 92ebae9 into bluesky:main Apr 10, 2024
6 of 8 checks passed
@danielballan danielballan deleted the catalog-explanation-docs branch April 11, 2024 14:38
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.

3 participants