main page file deduplication & broken links with rdoc 8

Aberta
#1,750 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
48/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Pouca atividade
Stack de tecnologia
ruby
Domínio
documentation

Direção de pesquisa

Comece revisando o PR #1624 e compare as saídas geradas pelo RDoc 7 e pelo RDoc 8 para README_md.html e index.html. Rastreie como a URL da página principal e os links de entrada são selecionados; em seguida, defina e verifique o comportamento esperado para os links existentes de README_md.html sem restaurar conteúdo redundante.

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

Descrição

PR #1624 removed the redundant main-page file. That is easily the correct behaviour, but existing projects may have that URL published/indexed/linked externally, and regenerating with rdoc 8 could now break inbound links.

In my own case, a README_md.html no longer existed because it duplicated index.html, and this broke one of my own bookmarks to my own project because I hadn't pinned rdoc 7 for the CI publish action. No doubt other folks will also get some surprise 404s.

Linguagem predominante
Ruby
Estrelas
928
Forks
471
Merge médio
2d 4min
PRs com merge (30d)
13

Preparar o ambiente

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 ruby/rdoc

Todas as issues de ruby/rdoc

Issues semelhantes

Mais issues de Ruby

Receba novas issues na sua caixa de entrada

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