docs: modify run pika in docker readme #2743
Conversation
|
Warning Rate limit exceeded@luky116 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 36 minutes and 1 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 changes modify the Changes
Assessment against linked issues
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 Configration File (
|
github-actions
bot
added
Invalid PR Title
📒 Documentation
luky116
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~274-~274: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...veral optional parameters: *-t tag: Specify the Docker tag for the image. B...
[uncategorized] ~275-~275: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...pikadb/pika:. *-p platform: Specify the platform for the Docker ima...
[uncategorized] ~276-~276: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...t docker platform setting. *--proxy: Use a proxy to download packages to spe...
[style] ~276-~276: Consider using a different verb to strengthen your wording. (SPEED_UP_ACCELERATE)
Context: ...y`: Use a proxy to download packages to speed up the build process. The build will use A...
[uncategorized] ~277-~277: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ibaba Cloud's image source. *--help: Display help information. Here is ...
[style] ~530-~530: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...db size, log size, memory usage etc. 3. Pika Client Info: The number of connected cl...
[style] ~531-~531: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...fo: The number of connected clients. 4. Pika Stats Info: status information of compa...
[style] ~532-~532: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...s information of compact, slot, etc. 5. Pika Network Info: Incoming and outgoing tra...
[style] ~533-~533: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...client and master-slave replication. 6. Pika CPU Info: cpu usage. 7. Pika Replicatio...
[style] ~534-~534: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...cation. 6. Pika CPU Info: cpu usage. 7. Pika Replication Info: Status information of...
[style] ~535-~535: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ave replication, binlog information. 8. Pika Keyspace Info: key information of five ...
[style] ~536-~536: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ... key information of five data types. 9. Pika Command Exec Count Info: command execut...
[style] ~537-~537: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ount Info: command execution count. 10. Pika Command Execution Time: Time-consuming ...
Markdownlint
README.md
547-547: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
548-548: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
549-549: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
316-316: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
317-317: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
318-318: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
319-319: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
320-320: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
321-321: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
322-322: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
306-306: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
101-101: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
328-328: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
523-523: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
179-179: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
205-205: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
288-288: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
553-553: null (MD045, no-alt-text)
Images should have alternate text (alt text)
312-312: Expected: asterisk; Actual: underscore (MD050, strong-style)
Strong style
312-312: Expected: asterisk; Actual: underscore (MD050, strong-style)
Strong style
Additional comments not posted (1)
README.md (1)
255-262: Ensure the updated Docker run command reflects the new path configurations correctly.The changes made to the Docker run command and the associated volume mappings are appropriate for addressing the path issues described in the linked issue. This should help in resolving the rsync errors by ensuring the directories are correctly mapped and accessible within the Docker container.
chejinge
changed the title
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range and nitpick comments (1)
README.md (1)
255-261: Consider adding a brief explanation for each configuration change.It might be beneficial for users, especially those new to Pika, to understand why these specific paths (
/data/log/,/data/db/, etc.) are chosen and how they relate to resolving the rsync issue mentioned in the PR.Tools
Markdownlint
256-256: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
255-255: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
256-256: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~281-~281: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...veral optional parameters: *-t tag: Specify the Docker tag for the image. B...
[uncategorized] ~282-~282: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...pikadb/pika:. *-p platform: Specify the platform for the Docker ima...
[uncategorized] ~283-~283: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...t docker platform setting. *--proxy: Use a proxy to download packages to spe...
[style] ~283-~283: Consider using a different verb to strengthen your wording. (SPEED_UP_ACCELERATE)
Context: ...y`: Use a proxy to download packages to speed up the build process. The build will use A...
[uncategorized] ~284-~284: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...ibaba Cloud's image source. *--help: Display help information. Here is ...
[style] ~537-~537: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...db size, log size, memory usage etc. 3. Pika Client Info: The number of connected cl...
[style] ~538-~538: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...fo: The number of connected clients. 4. Pika Stats Info: status information of compa...
[style] ~539-~539: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...s information of compact, slot, etc. 5. Pika Network Info: Incoming and outgoing tra...
[style] ~540-~540: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...client and master-slave replication. 6. Pika CPU Info: cpu usage. 7. Pika Replicatio...
[style] ~541-~541: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...cation. 6. Pika CPU Info: cpu usage. 7. Pika Replication Info: Status information of...
[style] ~542-~542: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ave replication, binlog information. 8. Pika Keyspace Info: key information of five ...
[style] ~543-~543: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ... key information of five data types. 9. Pika Command Exec Count Info: command execut...
[style] ~544-~544: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...ount Info: command execution count. 10. Pika Command Execution Time: Time-consuming ...
Markdownlint
README.md
554-554: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
555-555: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
556-556: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
323-323: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
324-324: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
325-325: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
326-326: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
327-327: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
328-328: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
329-329: Expected: 0; Actual: 2 (MD007, ul-indent)
Unordered list indentation
313-313: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
101-101: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
335-335: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
530-530: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
179-179: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
205-205: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
256-256: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
264-264: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
295-295: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
255-255: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
256-256: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
560-560: null (MD045, no-alt-text)
Images should have alternate text (alt text)
319-319: Expected: asterisk; Actual: underscore (MD050, strong-style)
Strong style
319-319: Expected: asterisk; Actual: underscore (MD050, strong-style)
Strong style
| @@ -252,14 +252,21 @@ Users can directly download the latest binary version package from [releases](ht | |||
|
|
|||
| * #### 3.1 Running with Docker | |||
|
|
|||
| ```bash | |||
| Modify the following configuration items of the conf file: | |||
| ``` | |||
There was a problem hiding this comment.
Specify the language for the code block to enhance readability and syntax highlighting.
-```
+```properties
log-path : /data/log/
db-path : /data/db/
db-sync-path : /data/dbsync/
dump-path : /data/dump/Specifying the language as properties for the configuration snippet will help in syntax highlighting and improve the readability of the documentation.
Tools
Markdownlint
256-256: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
256-256: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
| ``` | ||
|
|
||
| And then execute the following statement to start pika in docker: | ||
| ```bash |
There was a problem hiding this comment.
Add a blank line before the code block for proper markdown formatting.
- And then execute the following statement to start pika in docker:
+ And then execute the following statement to start pika in docker:
```bashA blank line before the code block will ensure it is properly formatted in markdown viewers.
Tools
Markdownlint
264-264: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
| ```bash | ||
| docker run -d \ | ||
| --restart=always \ | ||
| -p 9221:9221 \ | ||
| -v <log_dir>:/pika/log \ | ||
| -v <db_dir>:/pika/db \ | ||
| -v <dump_dir>:/pika/dump \ | ||
| -v <dbsync_dir>:/pika/dbsync \ | ||
| -v "$(pwd)/conf":"/pika/conf" \ | ||
| -v "/tmp/pika-data":"/data" \ |
There was a problem hiding this comment.
Ensure consistent formatting in Docker run commands.
- -v "$(pwd)/conf":"/pika/conf" \
- -v "/tmp/pika-data":"/data" \
+ -v "$(pwd)/conf:/pika/conf" \
+ -v "/tmp/pika-data:/data" \The volume mappings in the Docker command should not have spaces around the colon to ensure consistency and avoid potential issues in different environments or shells.
Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```bash | |
| docker run -d \ | |
| --restart=always \ | |
| -p 9221:9221 \ | |
| -v <log_dir>:/pika/log \ | |
| -v <db_dir>:/pika/db \ | |
| -v <dump_dir>:/pika/dump \ | |
| -v <dbsync_dir>:/pika/dbsync \ | |
| -v "$(pwd)/conf":"/pika/conf" \ | |
| -v "/tmp/pika-data":"/data" \ | |
| ```bash | |
| docker run -d \ | |
| --restart=always \ | |
| -p 9221:9221 \ | |
| -v "$(pwd)/conf:/pika/conf" \ | |
| -v "/tmp/pika-data:/data" \ |
Tools
Markdownlint
264-264: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
* modify readme * modify readme * modify readme * modify readme --------- Co-authored-by: liuyuecai <liuyuecai@360.cn>
* modify readme * modify readme * modify readme * modify readme --------- Co-authored-by: liuyuecai <liuyuecai@360.cn>
* modify readme * modify readme * modify readme * modify readme --------- Co-authored-by: liuyuecai <liuyuecai@360.cn>
fix #2740
Summary by CodeRabbit