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

Streamline and update installation instructions #39

Closed

Conversation

half-duplex
Copy link
Member

@half-duplex half-duplex commented Jul 27, 2022

Make the install instructions more streamlined for common goals and clarify which methods are recommended and recommended against. Also removes the ssl backports thing and the system requirements page, since pip installs all of that automatically, and if you're not using pip you should know how to handle it yourself.

  • Do we still use/need sopel.py on windows?
  • Can I simplify it further by pushing venvs? System-wide pip is disgusting and shouldn't be used except by people building docker containers, and they'll know how to adapt the instructions. Only concern is windows where I have no idea how any of this works.
  • Todo: Plugin install section

@dgw
Copy link
Member

dgw commented Nov 30, 2022

Do we still use/need sopel.py on windows?

sopel.py no longer exists in 8.0-dev (sopel-irc/sopel#2328, sopel-irc/sopel@866c339)

Can I simplify it further by pushing venvs? System-wide pip is disgusting and shouldn't be used except by people building docker containers, and they'll know how to adapt the instructions. Only concern is windows where I have no idea how any of this works.

I would personally leave both system-wide and venv methods documented, because in some cases setting up a venv will be a waste of time, and/or overwhelming to new users who've never run Python apps before. Global installation shouldn't be a problem if Sopel is the only (or one of very few) Python packages the user wants to try, and I would argue that it's likely someone already running multiple Python apps already knows about venvs.

No CI tests are run on Windows, so I think we're still at an "if it works, great" state. You can also leave the system-wide pip method for Windows, and/or suggest putting Sopel inside WSL (which uses the Linux instructions for whichever distro is run).

@dgw
Copy link
Member

dgw commented Nov 9, 2023

There's been quite a bit of work upstream on the Sphinx documentation, including a comprehensive guide on installing and running Sopel. See sopel-irc/sopel#2497 and sopel-irc/sopel#2533; we should simply remove and redirect duplicated pages from this website repo as part of the 8.0 launch process.

@dgw dgw mentioned this pull request Nov 9, 2023
@dgw dgw added the content label Dec 5, 2023
@dgw
Copy link
Member

dgw commented Dec 5, 2023

Merging of sopel-irc/sopel#2533 obviates most of this, so I'm going to close it out. venv-related follow-up belongs in the upstream docs now, if you're still motivated to make the installation guide cover that usage. (There's likely a third-party venv guide we could link to and reference, rather than reinventing that wheel.) These outdated pages should be redirected/removed as part of #38 and/or #45.

@dgw dgw closed this Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants