Update the README files under `scalardb` and `scalardl` directories - Githubissues

scalar-labs / scalar-jepsen

Jepsen tests for ScalarDB and ScalarDL

45 stars 6 forks source link

Update the README files under `scalardb` and `scalardl` directories #129

Closed komamitsu closed 3 months ago

komamitsu commented 3 months ago

Description

I noticed there is room to improve the README files under scalardb and scalardl directories. This PR updates the files.

Related issues and/or PRs

None

Changes made

Add missing necessary option --ssh-private-key option to the example command in scalardb/README.md
- Without the option, I failed to run the Jepsen test
- (Should I add it to scalardl/README.md as well?)
Replace Scalar DB with ScalarDB and Scalar DL with ScalarDL

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.

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

Additional notes (optional)

None