Free-programming-books: Consistência de listagens (procura-se ajuda)

Criado em 21 out. 2020  ·  5Comentários  ·  Fonte: EbookFoundation/free-programming-books

com a enxurrada de adições durante o Hacktoberfest, estou vendo alguns sites / editores / plataformas adicionados onde os links são apresentados de forma inconsistente.
Um exemplo são os livros de goleiro.
A maioria de nossas listas de chutadores se parece com isto:
* [Spring Framework Notes for Professionals](https://books.goalkicker.com/SpringFrameworkBook) - Compiled from StackOverflow documentation
Isso dá aos leitores uma ideia do que esperar e fornece a atribuição adequada. Mas nem todos os nossos links para o goleador são formatados da mesma maneira.

Da mesma forma, os links do wikibooks têm sido inconsistentes - já existe um PR trabalhando para resolver isso. # 4230

Nossa lista de cursos tem gasto muito e a atribuição da plataforma tem sido inconsistente. Deveria ser:
`* título conforme fornecido pelo recurso - Instrutor / Criador (plataforma)

As relações públicas para melhorar a consistência serão bem-vindas.

PR requested discussion help wanted

Todos 5 comentários

@eshellman Também notei essa inconsistência.

@SethiPandi o que você acha?

Você deve ter notado pelo tamanho de todas as minhas respostas, mas sempre fui um fã de verbosidade e desambiguação.

Acho que é sempre bom ser explícito, mesmo para coisas que um usuário sensato pode inferir, especialmente porque não há garantia de que todos os usuários serão sensatos.

A única coisa indiscutivelmente inferível em minha opinião é HTML, mas mesmo assim acho que é ideal, embora não precise ser obrigatório, especificá-lo. No entanto, não tenho certeza de onde o YouTube pode ser considerado deduzível.

_O seguinte representa apenas minha experiência pessoal, não o usuário comum._
Digo isso como alguém que esperava pessoalmente que todos os livros fossem PDFs até que percebi que a maioria, na verdade, não eram PDFs. (Prefiro ler offline no KOReader .)
Claro, eu conheço isso _agora_, mas não como uma pessoa que era nova no repositório e não estava familiarizada com as convenções.

Podemos eliminar 'YouTube' e 'Github "das listas. Para cursos, o nome da plataforma é mais útil porque as plataformas oferecem experiências mais variadas e podem ter requisitos de registro.

'HTML' deve ser indicado apenas quando é o único formato disponível - frequentemente nosso link leva a uma página da web que oferece links para conteúdo de vários tipos.

@eshellman ok, ótimo, parece bom

Precisamos compilar notas de consistência específicas do provedor. Então...

Please add the "Compiled from StackOverflow documentation" attribution we use for goalkicker books
For youtube, we prefer "playlist" links and the name of the producer/creators

de PRs:
MIT OpenCourseWare # 5087
Wikibooks # 4230
udacity # 3880
leanpub

Esta página foi útil?
0 / 5 - 0 avaliações

Questões relacionadas

ghost picture ghost  ·  17Comentários

aminought picture aminought  ·  15Comentários

iamsubhranil picture iamsubhranil  ·  6Comentários

eshellman picture eshellman  ·  9Comentários

kadhirash picture kadhirash  ·  4Comentários