-
Notifications
You must be signed in to change notification settings - Fork 270
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: validator command in the doc and add some context #846
fix: validator command in the doc and add some context #846
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks good to me but I think ci is going to complain about the line length on line 513
@jstarry comment fixed :) |
software. Refer again to | ||
software with the `sol` user. Refer again to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this modification is necessary. This is just a general note saying to make sure the CLI is installed, no command an earlier note already says that we'll be using the sol
user so this seems repetitive
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before on this page, you wrote to create a sol user.
https://docs.solanalabs.com/operations/setup-a-validator#sol-user
I believe if you recommand to create a sol user, then installation CLI should be installed by this sol user right?
I was myself confused if I had to install the CLI with the sol user or with the root user following each instructions on this page. I had to ask someone on the discord for clarification.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ahh I see, I was a little confused based on where you added "with the sol user" in the sentence. At the end there, it seems to be reinforcing that the validator will be run with sol
user, not which user to use to install it.
Before on this page, you wrote to create a sol user. https://docs.solanalabs.com/operations/setup-a-validator#sol-user
Yep, and shortly after that bit we have this note
It is a best practice to always run your validator as a non-root user, like the sol user we just created.
Altho it doesn't directly say it, this comment implies that the CLI needs to be accessible to user sol
I believe if you recommand to create a sol user, then installation CLI should be installed by this sol user right? I was myself confused if I had to install the CLI with the sol user or with the root user following each instructions on this page. I had to ask someone on the discord for clarification.
Technically it isn't required, but to keep things simplest, yes, the CLI should be installed with user sol
.
Now that I understand your point of view, I'm in favor of it. However, I think it is a little ambiguous where you added the note. How about an extra (but short) sentence:
software. Refer again to | |
software with the `sol` user. Refer again to | |
software. For simplicity, install the cli with user `sol`. Refer again to |
😱 New commits were pushed while the automerge label was present. |
@steviez I added your fix suggestion to the PR :) |
@steviez I added your suggestion! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the changes!
Problem
some commands in the docs are wrong and some context is missing
Summary of Changes
fixing the command and adding some context