Fix typo #141
Fix typo #141
Conversation
WalkthroughThe updates modify default port configurations for profiling and RPC services in the CLI and self-hosted server documentation. Profiling now defaults to port 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 Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (3)
docs/self-hosted-server.mdx (3)
Line range hint
46-46: Consider adding "the" before "metrics" to improve grammatical correctness.- Server exports metrics under the `/metrics` path on its profiling port. + Server exports the metrics under the `/metrics` path on its profiling port.
Line range hint
96-96: Consider adding "a" before "sharded cluster" to clarify the sentence.- This page describes how to set up sharded cluster. + This page describes how to set up a sharded cluster.
Line range hint
136-136: Consider adding "a" before "guide" to improve the grammatical structure.- Below is guide for deploying Yorkie cluster addons on Kubernetes. + Below is a guide for deploying Yorkie cluster addons on Kubernetes.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/cli.mdx (2 hunks)
- docs/self-hosted-server.mdx (2 hunks)
Additional context used
LanguageTool
docs/self-hosted-server.mdx
[uncategorized] ~46-~46: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...erving RPC on 8080 ``` ### Monitoring Server exports metrics under the/metricspa...
[uncategorized] ~59-~59: The determiner “these” seems more likely in this context. (AI_EN_LECTOR_REPLACEMENT_DETERMINER)
Context: ...hpull_received_changes_total 6 ... ``` This metrics can be collected from [Promethe...
[uncategorized] ~84-~84: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...son) and customize it. For instance, if Prometheus data source name ismy-prometheus, th...
[uncategorized] ~96-~96: You might be missing the article “a” here. (AI_EN_LECTOR_MISSING_DETERMINER_A)
Context: ...nts. This page describes how to set up sharded cluster. An example of the sharded clus...
[uncategorized] ~136-~136: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...ntinuous Delivery via ArgoCD. Below is guide for deploying Yorkie cluster addons on ...docs/cli.mdx
[uncategorized] ~120-~120: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...sted server](/docs/self-hosted-server), default username and password areadminand `...
[style] ~145-~145: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...Projects as needed, for example, if you want to manage [auth webhook](/docs/cli#auth-we...
[uncategorized] ~177-~177: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... 15 minutes ``` _Server creates adefault projectautomatical...
[uncategorized] ~177-~177: You might be missing the article “an” here. (AI_EN_LECTOR_MISSING_DETERMINER_AN)
Context: ...tically. If you create a Client without apiKey, the Client is created in the default P...
[uncategorized] ~224-~224: A determiner appears to be missing. Consider inserting it. (AI_EN_LECTOR_MISSING_DETERMINER)
Context: ...T09:27:06.0588974Z"} ``` ### Document Document is a data structure that can be synchro...
[formatting] ~269-~269: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence. (WITH_THAT_COMMA)
Context: ...rol the output of the command. With the flags you can paginate the output. You can u...
[uncategorized] ~271-~271: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...u can paginate the output. You can use--sizeflag to limit the number of docu...
[uncategorized] ~279-~279: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... ... ... ``` You can use--previous-idflag to start after a spe...
[style] ~287-~287: 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: ... ... ... ... ``` You can use--forwardflag to search forw...
[uncategorized] ~288-~288: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... ... ... ``` You can use--forwardflag to search forward or bac...
[typographical] ~381-~381: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... outside server, it handles the request normally, otherwise it sends thecodes.Unauthenticateder...
[uncategorized] ~387-~387: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...gn/garbage-collection.md). You can set client deactivate threshold of the project wit...
[uncategorized] ~387-~387: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ...eactivate threshold of the project with--client-deactivate-thresholdflag. ``...
Gitleaks
docs/cli.mdx
185-185: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
185-185: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
192-192: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
220-220: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
220-220: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
391-391: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
391-391: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
Additional comments not posted (3)
docs/self-hosted-server.mdx (1)
21-23: Updated backend IDs and service ports reflect the new configurations correctly.docs/cli.mdx (2)
103-107: Updated default ports for profiling and RPC are correctly documented.
130-130: The context subcommand output is accurately documented.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/cli.mdx (2 hunks)
- docs/self-hosted-server.mdx (5 hunks)
Additional context used
LanguageTool
docs/self-hosted-server.mdx
[uncategorized] ~46-~46: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...erving RPC on 8080 ``` ### Monitoring Server exports metrics under the/metricspa...
[uncategorized] ~62-~62: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...grafana/) is the easiest way to monitor Server's metrics. First, download all manifes...
[uncategorized] ~96-~96: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...nts. This page describes how to set up sharded cluster. An example of the sharded clus...
[uncategorized] ~122-~122: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...eploy Yorkie cluster on Kubernetes with above components configured. Below are guide...
[uncategorized] ~136-~136: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...ntinuous Delivery via ArgoCD. Below is guide for deploying Yorkie cluster addons on ...docs/cli.mdx
[style] ~145-~145: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ...Projects as needed, for example, if you want to manage [auth webhook](/docs/cli#auth-we...
[uncategorized] ~195-~195: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ..., // public_key of the project }); ``` Then Documents attached to the Client are is...
[formatting] ~269-~269: Consider inserting a comma here, unless the first half is essential to the meaning of the sentence. (WITH_THAT_COMMA)
Context: ...rol the output of the command. With the flags you can paginate the output. You can u...
[style] ~287-~287: 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: ... ... ... ... ``` You can use--forwardflag to search forw...
[typographical] ~381-~381: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... outside server, it handles the request normally, otherwise it sends thecodes.Unauthenticateder...
[uncategorized] ~394-~394: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...s will help document GC by not counting deactivated client's document sequence.
Gitleaks
docs/cli.mdx
185-185: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
185-185: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
192-192: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
220-220: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
220-220: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
391-391: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
391-391: Detected a Generic API Key, potentially exposing access to various services and sensitive operations. (generic-api-key)
Additional comments not posted (5)
docs/self-hosted-server.mdx (3)
21-23: LGTM! The updated ports for RPC and profiling are correctly documented.
40-42: This correction aligns the RPC documentation with the port changes. Good catch!
51-51: Ensure the profiling port matches the new configuration throughout all examples.Verification successful
Ensure the profiling port matches the new configuration throughout all examples. The port
8081is consistently used across the documentation.
docs/self-hosted-server.mdxdocs/cli.mdxScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the consistency of the profiling port usage. # Test: Search for profiling port mentions. Expect: Only occurrences of the new port `8081`. rg --type mdx $'8081' docs/Length of output: 54
Script:
#!/bin/bash # Description: Verify the consistency of the profiling port usage. # Test: Search for profiling port mentions in .mdx files. Expect: Only occurrences of the new port `8081`. rg '8081' --glob '*.mdx' docs/Length of output: 302
docs/cli.mdx (2)
103-103: The updated default profiling port is correctly documented.
107-107: The updated default RPC port is correctly documented.
What this PR does / why we need it?
Fix typo
Any background context you want to provide?
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
8081) and RPC (8080) in CLI tool documentation.8080for RPC and8081for profiling).