Update dbs docs #167
Update dbs docs #167
Conversation
|
Warning Rate limit exceeded@GAtom22 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 35 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe document on database configurations for the Evmos protocol has undergone substantial enhancements. Key updates include an increase in the minimum required Golang version and an upgrade in the recommended Evmos source code version. The sections on PebbleDB and RocksDB have been expanded with clearer installation instructions and updated dependency versions, ensuring users have the most current information for effective implementation. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
✅ Deploy Preview for dancing-hummingbird-242a98 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 20
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/protocol/evmos-cli/alternative-dbs.md (8 hunks)
Additional context used
LanguageTool
docs/protocol/evmos-cli/alternative-dbs.md
[grammar] ~16-~16: It seems that a pronoun is missing.
Context: .../evmos/evmos) version. For example, if want to usev19.0.0, execute the foll...(IF_VB)
[style] ~39-~39: ‘previous to’ might be wordy. Consider a shorter alternative.
Context: ... :::warning NOTE: if using a version previous to v19, you'll need to replace the comet...(EN_WORDINESS_PREMIUM_PREVIOUS_TO)
[grammar] ~76-~76: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ld-docker-pebbledb ``` ## Rocks DB To setup a node with rocksDB, you need to instal...(NOUN_VERB_CONFUSION)
[uncategorized] ~80-~80: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...plies to Ubuntu OS. For other operating system, refer to the [rocksdb installation gui...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~90-~90: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...gs-dev ``` If this doesn't work and you're using Ubuntu, [here's a nice tut...(COMMA_COMPOUND_SENTENCE)
Markdownlint
docs/protocol/evmos-cli/alternative-dbs.md
14-14: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
15-15: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
84-84: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
92-92: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
98-98: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
104-104: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
110-110: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
116-116: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
122-122: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
128-128: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
256-256: Expected: 120; Actual: 128
Line length(MD013, line-length)
251-251: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
252-252: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
256-256: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
283-283: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
Additional comments not posted (8)
docs/protocol/evmos-cli/alternative-dbs.md (8)
14-15: Update Golang version requirement.The Golang version requirement has been updated to
>=1.22.2. Ensure that all users are aware of this new requirement.Tools
Markdownlint
14-14: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
15-15: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
19-19: Update example version forevmosdsource code.The example version for
evmosdsource code has been updated tov19.0.0. Ensure that all users follow this updated example.
24-29: Add commands for compiling and installingevmosdbinary with PebbleDB support.The new commands provide clear instructions for compiling and installing the
evmosdbinary with PebbleDB support.
31-36: Add instructions for checking the binary version.The instructions emphasize the importance of checking the binary version to ensure the
-pebbledbsuffix is present.
84-132: Update installation commands for dependencies.The installation commands for various dependencies have been updated and reformatted for clarity.
Tools
LanguageTool
[uncategorized] ~90-~90: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...gs-dev ``` If this doesn't work and you're using Ubuntu, [here's a nice tut...(COMMA_COMPOUND_SENTENCE)
Markdownlint
84-84: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
92-92: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
98-98: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
104-104: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
110-110: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
116-116: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
122-122: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
128-128: Expected: 1; Actual: 3
Spaces after list markers(MD030, list-marker-space)
151-156: Updategrocksdbdependency version.The
grocksdbdependency version has been updated tov1.9.2, which supports RocksDBv9.2.1.
165-165: Update installation command forlibrocksdb.The command to clone the
librocksdbrepository has been updated to versionv9.2.1.
222-222: Add instructions for checking the binary version.The instructions emphasize the importance of checking the binary version to ensure the
-rocksdbsuffix is present.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/protocol/evmos-cli/alternative-dbs.md (7 hunks)
Additional context used
LanguageTool
docs/protocol/evmos-cli/alternative-dbs.md
[grammar] ~16-~16: It seems that a pronoun is missing.
Context: ...om/evmos/evmos) version. For example, if want to usev19.0.0, execute the foll...(IF_VB)
[grammar] ~77-~77: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ld-docker-pebbledb ``` ## Rocks DB To setup a node with rocksDB, you need to instal...(NOUN_VERB_CONFUSION)
Additional comments not posted (6)
docs/protocol/evmos-cli/alternative-dbs.md (6)
14-14: Approved: Update Golang version requirement.The Golang version requirement has been correctly updated to
>=1.22.2.
16-19: Approved: Update example version forevmosdsource code.The example version for
evmosdsource code has been correctly updated tov19.0.0.Tools
LanguageTool
[grammar] ~16-~16: It seems that a pronoun is missing.
Context: ...om/evmos/evmos) version. For example, if want to usev19.0.0, execute the foll...(IF_VB)
39-39: Approved: Simplify wording.The phrase "previous to" has been correctly simplified to "before".
152-152: Approved: Updategrocksdbdependency version.The
grocksdbdependency version has been correctly updated tov1.9.2.
157-157: Approved: Updatelibrocksdbversion requirement.The
librocksdbversion requirement has been correctly updated tov9.2.1.
223-223: Approved: Update binary version check.The binary version check has been correctly updated to ensure the
-rocksdbsuffix is present.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/protocol/evmos-cli/alternative-dbs.md (7 hunks)
Additional context used
LanguageTool
docs/protocol/evmos-cli/alternative-dbs.md
[grammar] ~77-~77: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ld-docker-pebbledb ``` ## Rocks DB To setup a node with rocksDB, you need to instal...(NOUN_VERB_CONFUSION)
Additional comments not posted (9)
docs/protocol/evmos-cli/alternative-dbs.md (9)
14-14: LGTM! Golang version requirement update.The Golang version requirement has been correctly updated to
>=1.22.2.
16-19: LGTM! Example version update.The example version for
evmosdsource code has been correctly updated tov19.0.0.
24-29: LGTM! Added commands for PebbleDB support.The new commands for compiling and installing the
evmosdbinary with PebbleDB support are correctly formatted.
31-36: LGTM! Added instructions for verifying binary version.The new instructions for verifying the binary version with the
-pebbledbsuffix are correctly formatted.
Line range hint
38-56: LGTM! Added warning note and commands for cometbft-db dependency.The new warning note and commands for replacing the cometbft-db dependency for versions prior to
v19are correctly formatted.
66-73: LGTM! Added commands for building docker image with PebbleDB support.The new commands for building a docker image with the
evmosdbinary compiled to use PebbleDB are correctly formatted.
152-157: LGTM! Updatedgrocksdbdependency version.The
grocksdbdependency version has been correctly updated tov1.9.2.
159-166: LGTM! Updatedlibrocksdbversion requirement.The
librocksdbversion requirement has been correctly updated tov9.2.1.
81-81: Fix grammatical number: Use "operating systems" instead of "operating system".The phrase "operating system" should be plural.
- For other operating system, refer to the [rocksdb installation guide](https://github.com/facebook/rocksdb/blob/v9.2.1/INSTALL.md). + For other operating systems, refer to the [rocksdb installation guide](https://github.com/facebook/rocksdb/blob/v9.2.1/INSTALL.md).Likely invalid or redundant comment.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Summary by CodeRabbit
1.20+to>=1.22.2.evmosdsource code version fromv14.0.0tov19.0.0.