freeCodeCamp/devdocs

Chef docs are outdated (and never will be updated)

Open

#927 aberto em 6 de nov. de 2018

Ver no GitHub
 (2 comments) (2 reactions) (0 assignees)Ruby (2.598 forks)batch import
docs/updatehelp wanted

Métricas do repositório

Stars
 (38.907 stars)
Métricas de merge de PR
 (Mesclagem média 23d 15h) (7 fundiu PRs em 30d)

Description

The Chef docs are created from an archive that resides here https://docs-archive.chef.io/. These docs are not updated any more, which I was told on Slack by a Chef employee (sorry for not having anything written down). The chef docs moved to a style of documentation that is independent of the chef version, so scraping the cookbooks reference from the official docs page (https://docs.chef.io/cookbooks.html) would probably the best approach.

Guia do colaborador

Direção de pesquisa
A issue sugere substituir o arquivo de documentação desatualizado do Chef por conteúdo extraído de https://docs.chef.io/cookbooks.html. Como não há PRs ou comentários recentes, comece examinando como outras fontes de documentação são extraídas na base de código do devdocs (provavelmente no diretório 'lib/docs/scrapers'). Verifique o extrator do Chef existente, se houver, e adapte o para analisar a nova estrutura HTML. Observe que a documentação oficial do Chef pode ter mudado desde 2018, então verifique a estrutura atual da página antes de implementar.
Pilha de tecnologia
ruby
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
GitRuby
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75