Skip to content
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

Make systemd guide clearer on obtaining username and python path #3537

Merged
merged 3 commits into from Feb 11, 2020
Merged

Make systemd guide clearer on obtaining username and python path #3537

merged 3 commits into from Feb 11, 2020

Conversation

zephyrkul
Copy link
Contributor

@zephyrkul zephyrkul commented Feb 10, 2020

Type

  • Docs

Description of the changes

Resolves #3462

@jack1142 jack1142 added the Category: Docs label Feb 10, 2020
@jack1142 jack1142 added this to the 3.3.2 milestone Feb 10, 2020
@jack1142 jack1142 self-assigned this Feb 10, 2020
Copy link
Member

@jack1142 jack1142 left a comment

One change on clarity needed

@@ -24,7 +24,7 @@ Then create the new service file:

:code:`sudo -e /etc/systemd/system/red@.service`

Paste the following and replace all instances of :code:`username` with the username, and :code:`path` with the location you obtained above:
Paste the following and replace all instances of :code:`username` with your Linux username (you can use the :code:`whoami` command if you're unsure), and :code:`path` with the location you obtained above:
Copy link
Member

@jack1142 jack1142 Feb 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is imo a little unclear on why would user want to use this command, I think adding something like "if you're unsure what your username is" would be enough here, but anything that makes it more clear when you should use the command and/or what is the reader "unsure" of is gonna work here so if you think something would fit better here, you can of course put that instead ;)

Suggested change
Paste the following and replace all instances of :code:`username` with your Linux username (you can use the :code:`whoami` command if you're unsure), and :code:`path` with the location you obtained above:
Paste the following and replace all instances of :code:`username` with your Linux username (you can use the :code:`whoami` command if you're unsure what your username is), and :code:`path` with the location you obtained above:

Copy link
Contributor Author

@zephyrkul zephyrkul Feb 11, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I decided to rewrite that section entirely since the whole thing was a little unclear at a couple points.

Copy link
Member

@jack1142 jack1142 left a comment

Thanks for the PR

@jack1142 jack1142 changed the title [Docs] Make username clearer in autorestart guide Make systemd guide clearer on obtaining username and python path Feb 11, 2020
@jack1142 jack1142 merged commit da3f86d into Cog-Creators:V3/develop Feb 11, 2020
5 checks passed
@zephyrkul zephyrkul deleted the patch-1 branch Feb 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants