Installation instructions are abominably awful, feel like abandonware

Abierto
  • ¿Algo no está bien?
#156 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
html, hugo
Área
documentation

Línea de trabajo

Comienza con la página de destino enlazada y la sección de instalación; después localiza la fuente de Hugo correspondiente en el repositorio del sitio web. Revisa las pestañas de instalación, las advertencias y los enlaces de pipx desde la perspectiva de una persona recién llegada; se considera terminado cuando la página de destino lleva a la instalación y presenta claramente un método recomendado sin indicaciones confusas.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Installation should be easy, but Poetry is anything but, due to this website.

First, the landing page does not even mention or directly link to installation. If I arrive there and think "this looks cool, where do I click to install", there is nothing. No "click here to install", nothing. I have to guess that Documentation > Introduction contains an Installation section.

That installation section begins with a confusing warning about virtual environments, but FAILS TO RECOMMEND an installation method. Instead it has 4 tabs.

The first is pipx. Foolish. If you want adoption, your first installation method should not require another 3rd party program. A third of potential new adopters have just clicked away, assuming Poetry is too much trouble and too niche to even install itself.

Then there is With Official Installer. That sounds promising. Why is "the official installer" not the first tab? New users are confused. But it begins with this warning:

image

WTF does this even mean? Is install-poetry.py the same as "The installer script" we are installing? Why is a red "STOP" error message at the top of this "official" installation method? Should a new user conclude that this "official" "installer script" is now deprecated in favor of something else? 60% of your remaining potential new adopters have clicked away, confused and annoyed at the troublesome abandonware they were recommended. Note that the linked installer script seems to have some issue with current Windows 11 + Python 3.13.

Obviously, someone who has used Poetry for years knows the answers to the above questions, but that's not the point. These are all problems new users encounter when directed to use Poetry. Read your website from the point of view of a new user you're selling to. Make a recommended TLDR "DO THIS IF UNSURE" method plainly visible as the first tab, one that applies to new users who don't use pipx or popy or whatever trend of the year, without any years-old warnings that don't apply to them. New users want simplicity, not complexity. They are coming to Poetry to make their lives easier.

When I point dev after dev to poetry and their installation experience is the above, that's a problem. Companies spend millions on SEO / easy onboarding. Poetry could at least spend 5 minutes to stop driving away 90% of its potential new adopters.

PS

Let's follow the first tab, pipx, as a new user. Step 1 is "Install pipx":

If pipx is not already installed, you can follow any of the options in the official pipx installation instructions. Any non-ancient version of pipx will do.

Ok, I guess we can install one third-party tool, let's follow that link and ...

image

lol. Is the problem evident yet?

Lenguaje dominante
HTML
Estrellas
39
Forks
21
Merge medio
15 min
PR fusionados (30 d)
3

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de python-poetry/website

Todos los issues de python-poetry/website

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.