Installation instructions are abominably awful, feel like abandonware

Aberta
  • Algo errado?
#156 6 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
html, hugo
Domínio
documentation

Direção de pesquisa

Comece pela landing page vinculada e pela seção de instalação; em seguida, localize a fonte Hugo correspondente no repositório do site. Revise as abas de instalação, os avisos e os links do pipx pela perspectiva de alguém que está começando; considera-se concluído quando a landing page leva à instalação e apresenta claramente um método recomendado, sem orientações confusas.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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?

Linguagem predominante
HTML
Estrelas
39
Forks
21
Merge médio
15min
PRs com merge (30d)
3

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de python-poetry/website

Todas as issues de python-poetry/website

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.