Update Docs:CLI related with Account Management #165
Conversation
|
|
|
Warning Rate limit exceeded@hackerwins has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 22 minutes and 14 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 command syntax for logging into the Yorkie server via the CLI has been updated. The password parameter has been removed from the command line, and users will now be prompted to enter their password interactively. The logout command has been modified to align with the new structure, and new commands for changing the password and deleting the account have also been introduced, enhancing overall functionality. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli.mdx (1 hunks)
Additional comments not posted (2)
docs/cli.mdx (2)
115-116: LGTM!The changes to the login command are approved. The new command simplifies the login process and improves security by not exposing the password in the command line.
117-121: LGTM!The added information about the password prompt enhances the user experience by setting the right expectations. The information is clear and consistent with the actual behavior of the CLI.
There was a problem hiding this comment.
Thanks for your contribution. Please check the comments below.
- The command
$ yorkie logoutshould be updated to$ yorkie user logout. - Please include usage instructions for the following commands:
yorkie user delete-account -u <username>yorkie user change-password -u <username>
- Ensure proper spacing throughout the documentation to improve readability.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/cli.mdx (1)
137-161: LGTM with a minor suggestion!The changes to the logout command and the addition of the change password and delete account commands look good. They enhance the CLI's functionality and user experience.
The static analysis tool has flagged a style issue about repetitive phrasing in the change password and delete account sections. Consider rephrasing the following sentences to add variety to the writing:
- "If you want to change your password, you can use the command
change-password."- "If you want to delete your account, you can use the command
delete-account."For example, you could rephrase them as:
- "To change your password, use the
change-passwordcommand."- "To delete your account, use the
delete-accountcommand."Tools
LanguageTool
[style] ~146-~146: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...UgofYg ``` ### Change Password If you want to change your password, you can use the c...(REP_WANT_TO_VB)
[style] ~154-~154: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ssword: Enter New Password: ``` If you want to delete your account, you can use the co...(REP_WANT_TO_VB)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli.mdx (2 hunks)
Additional context used
LanguageTool
docs/cli.mdx
[style] ~146-~146: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...UgofYg ``` ### Change Password If you want to change your password, you can use the c...(REP_WANT_TO_VB)
[style] ~154-~154: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ssword: Enter New Password: ``` If you want to delete your account, you can use the co...(REP_WANT_TO_VB)
Additional comments not posted (3)
docs/cli.mdx (3)
115-116: LGTM!The changes to the login command look good. Removing the password parameter from the command line and prompting for it interactively improves security.
119-119: LGTM!The note about the password entry is a helpful addition for users.
123-123: LGTM!The note about logging in to a self-hosted server is a helpful addition for users.
|
@sigmaith Could you sign up the CLA? |
|
Oh, I missed it. I just signed it! |
|
@sigmaith |
|
Thank you for mention. I'll do it. |
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli.mdx (2 hunks)
Additional context used
LanguageTool
docs/cli.mdx
[style] ~155-~155: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ofYg ``` ### Change Password If you want to change your password, you can use the c...(REP_WANT_TO_VB)
[grammar] ~155-~155: Use a predeterminer before a determiner. Did you mean “both The”? Possibly, a hyphen is missing, as in ‘an all-dance show’.
Context: ...word, you can use the commandpasswd. The both passwords will not be visible, which is...(DT_PDT)
[style] ~166-~166: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...sword: ``` ### Delete Account If you want to delete your account, you can use the co...(REP_WANT_TO_VB)
[grammar] ~177-~177: A verb may be missing. Did you mean “it has”, “it is” or “it does”?
Context: ...operation fails, please double-check if it the account exists and whether the pass...(IF_YOU_ANY)
Additional comments not posted (1)
docs/cli.mdx (1)
142-152: Logout command documentation updated.The logout command documentation has been updated to reflect the new structure. This change aligns with the modifications made to the login process, ensuring consistency across the documentation.
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli.mdx (2 hunks)
Additional context used
LanguageTool
docs/cli.mdx
[style] ~155-~155: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ofYg ``` ### Change Password If you want to change your password, you can use the c...(REP_WANT_TO_VB)
[style] ~166-~166: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...sword: ``` ### Delete Account If you want to delete your account, you can use the co...(REP_WANT_TO_VB)
Additional comments not posted (2)
docs/cli.mdx (2)
117-121: Update login command documentation to reflect interactive password entry.The documentation has been updated to reflect the new login command syntax which enhances security by not exposing the password in the command line. This is a significant improvement in terms of security best practices.
142-144: Logout command documentation updated.The logout command documentation has been updated to reflect the new structure. This change aligns with the login command's security enhancements.
sigmaith
changed the title
There was a problem hiding this comment.
Actionable comments posted: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/cli.mdx (2 hunks)
Additional context used
LanguageTool
docs/cli.mdx
[style] ~149-~149: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ofYg ``` ### Change Password If you want to change your password, you can use the c...(REP_WANT_TO_VB)
[style] ~160-~160: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...sword: ``` ### Delete Account If you want to delete your account, you can use the co...(REP_WANT_TO_VB)
hackerwins
force-pushed
the
change-cli-about-user
branch
from
b55513f to
b6cff07
Compare
hackerwins
force-pushed
the
change-cli-about-user
branch
from
b6cff07 to
09d12bb
Compare
What this PR does / why we need it?
I have updated the CLI command information documentation following the changes related to the user-related CLI in yorkie-team/yorkie.
Any background context you want to provide?
This is related to this issue. yorkie-team/yorkie#983
What are the relevant tickets?
Fixes #
Checklist
Summary by CodeRabbit
New Features
Documentation