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

Revise ScalarDB design doc #1335

Merged
merged 3 commits into from
Dec 12, 2023
Merged

Revise ScalarDB design doc #1335

merged 3 commits into from
Dec 12, 2023

Conversation

josh-wong
Copy link
Member

Description

This PR revises the ScalarDB design doc to direct readers to the paper that we presented at the VLDB 2023 conference. Pointing readers to the paper is similar to what we have done for the ScalarDL design doc.

Related issues and/or PRs

N/A

Changes made

Revised contents.

The following is a screenshot of design.md on the docs site (locally).

design

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

Please see the comments in the document.

Release notes

N/A

Revise contents to match the publicly available ScalarDL design doc.
@josh-wong josh-wong self-assigned this Nov 29, 2023
docs/design.md Outdated Show resolved Hide resolved
@josh-wong josh-wong marked this pull request as ready for review November 29, 2023 02:42
[skip ci]
docs/design.md Outdated
- [Making Cassandra more capable, faster, and more reliable](https://speakerdeck.com/scalar/making-cassandra-more-capable-faster-and-more-reliable-at-apachecon-at-home-2020) at ApacheCon@Home 2020
- [Scalar DB: A library that makes non-ACID databases ACID-compliant](https://speakerdeck.com/scalar/scalar-db-a-library-that-makes-non-acid-databases-acid-compliant) at Database Lounge Tokyo #6 2020
- [Transaction Management on Cassandra](https://speakerdeck.com/scalar/transaction-management-on-cassandra) at Next Generation Cassandra Conference / ApacheCon NA 2019
For details about the design and implementation of ScalarDB, please see the following paper that we presented at the VLDB 2023 conference: [ScalarDB: Universal Transaction Manager for Polystores](https://dl.acm.org/doi/10.14778/3611540.3611563)
Copy link
Contributor

Choose a reason for hiding this comment

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

It might be worth additionally introducing https://speakerdeck.com/scalar/scalardb-universal-transaction-manager-for-polystores-vldb23 as a light introduction?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh! I didn't realize (or forgot) that that slide deck was available publicly. I think that could help provide a good introduction to ScalarDB, with the paper being mentioned as a reference as well!

@feeblefakie @brfrn169 What do you think?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that's a good idea.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks! I've added that as the first link.

docs/design.md Outdated
- [Making Cassandra more capable, faster, and more reliable](https://speakerdeck.com/scalar/making-cassandra-more-capable-faster-and-more-reliable-at-apachecon-at-home-2020) at ApacheCon@Home 2020
- [Scalar DB: A library that makes non-ACID databases ACID-compliant](https://speakerdeck.com/scalar/scalar-db-a-library-that-makes-non-acid-databases-acid-compliant) at Database Lounge Tokyo #6 2020
- [Transaction Management on Cassandra](https://speakerdeck.com/scalar/transaction-management-on-cassandra) at Next Generation Cassandra Conference / ApacheCon NA 2019
For details about the design and implementation of ScalarDB, please see the following paper that we presented at the VLDB 2023 conference: [ScalarDB: Universal Transaction Manager for Polystores](https://dl.acm.org/doi/10.14778/3611540.3611563)
Copy link

Choose a reason for hiding this comment

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

It would be much more helpful to link to the presentation slides used at VLDB 2022 (or the recorded video, if available). I guess reading a full paper is a tough task for almost all 🫠.

Copy link
Member Author

@josh-wong josh-wong Dec 7, 2023

Choose a reason for hiding this comment

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

Agreed. I've added a link to the presentation slides, as you and @komamitsu suggested.

@feeblefakie Is there a video recording available from your presentation at VLDB 2023? I searched a bit but couldn't find any videos from the conference, even on the VLDB site or on YouTube.

@josh-wong josh-wong requested a review from komamitsu December 7, 2023 04:24
Copy link
Collaborator

@brfrn169 brfrn169 left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Contributor

@komamitsu komamitsu left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

Copy link
Contributor

@feeblefakie feeblefakie left a comment

Choose a reason for hiding this comment

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

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

Successfully merging this pull request may close these issues.

5 participants