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

Update DM instructions not always doable #6201

Closed
Vexed01 opened this issue Jul 13, 2023 · 2 comments
Closed

Update DM instructions not always doable #6201

Vexed01 opened this issue Jul 13, 2023 · 2 comments
Labels
Closed: Won't Fix It's supposed to be this way or we're not interested in fixing this. There's probably a good reason. Type: Enhancement Something meant to enhance existing Red features.

Comments

@Vexed01
Copy link
Contributor

Vexed01 commented Jul 13, 2023

What component of Red (cog, command, API) would you like to see improvements on?

Core / events

Describe the enhancement you're suggesting.

The current instructions assume all Linux users can open Terminal, though many Red users will be hosting on something without a GUI like Ubuntu Server. It would probably be a good idea to add something about running the command over a SSH connection if a window of Terminal isn't appropriate.

Anything else?

extra_update += _(
"\n\nTo update your bot, first shutdown your bot"
" then open a window of {console} (Not as admin) and run the following:"
"{command_1}\n"
"Once you've started up your bot again, we recommend that"
" you update any installed 3rd-party cogs with this command in Discord:"
"{command_2}"
).format(
console=_("Command Prompt") if platform.system() == "Windows" else _("Terminal"),
command_1=f'```"{sys.executable}" -m pip install -U "Red-DiscordBot{package_extras}"```',
command_2=f"```[p]cog update```",
)

@Vexed01 Vexed01 added the Type: Enhancement Something meant to enhance existing Red features. label Jul 13, 2023
@github-actions github-actions bot added the Status: Needs Triage This has not been labeled or discussed for handling yet. label Jul 13, 2023
@Dav-Git
Copy link
Contributor

Dav-Git commented Jul 14, 2023

While you are technically correct, I think this is a mental transfer we can expect people to make. If they managed to install red, they will probably manage to figure out where they need to run the command.

For the sake of keeping the message quick and easy to read I would be in favor of leaving it as is.

@Flame442
Copy link
Member

I would say the disclaimer provided in the earlier section is enough to make it clear that it isn't going to be perfectly accurate. Since we have no way to know if they are running it on a machine they need to SSH into or not, I don't think it makes sense to make that message even more wordy.

extra_update = _(
"\n\nWhile the following command should work in most scenarios as it is "
"based on your current OS, environment, and Python version, "
"**we highly recommend you to read the update docs at <{docs}> and "
"make sure there is nothing else that "
"needs to be done during the update.**"
).format(docs="https://docs.discord.red/en/stable/update_red.html")

@Flame442 Flame442 closed this as not planned Won't fix, can't repro, duplicate, stale Sep 27, 2023
@Flame442 Flame442 added Closed: Won't Fix It's supposed to be this way or we're not interested in fixing this. There's probably a good reason. and removed Status: Needs Triage This has not been labeled or discussed for handling yet. labels Sep 27, 2023
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Closed: Won't Fix It's supposed to be this way or we're not interested in fixing this. There's probably a good reason. Type: Enhancement Something meant to enhance existing Red features.
Projects
None yet
Development

No branches or pull requests

3 participants