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

DM-46034: Reorganize database documentation #294

Merged
merged 1 commit into from
Sep 3, 2024
Merged

DM-46034: Reorganize database documentation #294

merged 1 commit into from
Sep 3, 2024

Conversation

rra
Copy link
Member

@rra rra commented Aug 30, 2024

Break up the long database documentation page into pages focused on specific topics. Get rid of the arbitrary heading for "less-used operations" as part of that restructuring.

Reorganize the documentation about retrying database transactions to hopefully be a bit clearer.

@rra rra requested a review from jonathansick August 30, 2024 23:06
@rra
Copy link
Member Author

rra commented Aug 30, 2024

This is almost all just moving information around, so the only things to review here are the new structure and the tweaks to the way transaction retrying is described on the retry.rst page. Documentation for the testcontainers method of database testing is coming in a subsequent PR.

This PR is in preparation for adding documentation on how to use Alembic.

Break up the long database documentation page into pages focused
on specific topics. Get rid of the arbitrary heading for "less-used
operations" as part of that restructuring.

Reorganize the documentation about retrying database transactions
to hopefully be a bit clearer.
Copy link
Member

@jonathansick jonathansick left a comment

Choose a reason for hiding this comment

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

Looks like a good re-org to start with.

@rra rra merged commit 94991e0 into main Sep 3, 2024
6 checks passed
@rra rra deleted the tickets/DM-46034a branch September 3, 2024 20:59
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.

2 participants