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 more context to the "Getting Started with ScalarDB" doc to help users run the sample application #1018

Merged
merged 3 commits into from
Aug 21, 2023

Conversation

josh-wong
Copy link
Member

Description

This PR adds some context to the "Execute transactions and retrieve data in the basic electronic money application" section of the "Getting Started with ScalarDB" doc so that users can better follow and understand the sample application.

Related issues and/or PRs

Changes made

  • In the "Execute transactions and retrieve data in the basic electronic money application" section, I:
    • Added an explanation about what the application can do.
    • Added headings for each type transaction that users can execute in the application.
    • Revised the wording for executing the transactions.
  • I also made some minor wording changes and moved a sentence into a note block to better highlight the content.

Testing done

I ran our docs site locally and confirmed that this doc appears as expected with the addition of headings to the section for running the sample application.

Checklist

  • I have commented my code, particularly in hard-to-understand areas.
  • The documentation has been updated 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)

None.

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! 👍

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

@Torch3333 Torch3333 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.

LGTM! Thank you!

@feeblefakie feeblefakie merged commit 5da09a4 into master Aug 21, 2023
@feeblefakie feeblefakie deleted the revise-getting-started-doc branch August 21, 2023 11:26
feeblefakie pushed a commit that referenced this pull request Aug 22, 2023
feeblefakie pushed a commit that referenced this pull request Aug 22, 2023
feeblefakie pushed a commit that referenced this pull request Aug 22, 2023
feeblefakie pushed a commit that referenced this pull request Aug 22, 2023
feeblefakie pushed a commit that referenced this pull request Aug 22, 2023
@brfrn169
Copy link
Collaborator

brfrn169 commented Aug 22, 2023

@josh-wong The Auto-PR workflow automatically created PRs for 3.10 to 3.6. If you want a PR for 3.5 as well, can you please create it manually? 🙇

@josh-wong
Copy link
Member Author

@brfrn169 Will do. Thanks!

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