[docs-scanner] S3 and Azure Blob cache backends marked as unreleased but have complete documentation

Aberta Para iniciantes
  • Algo errado?
#26,599 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
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
66/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

Comece por content/manuals/build/cache/backends/_index.md e depois compare os rótulos de status de S3 e Azure Blob com s3.md e azblob.md no mesmo diretório. Confira o status do recurso com base nas evidências da documentação e, em seguida, deixe a visão geral e as páginas individuais consistentes; o trabalho estará concluído quando os leitores puderem saber se ambos os backends estão disponíveis ou são experimentais.

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

Descrição

File: content/manuals/build/cache/backends/_index.md

Issue

The main cache backends overview page marks S3 and Azure Blob Storage as "(unreleased)":

However, both s3.md and azblob.md in the same directory contain complete, production-ready documentation with:

  • Full synopsis and usage examples
  • Complete parameter tables
  • Authentication instructions
  • Summary bars indicating feature status (not unreleased status)
Why this matters

Readers see "(unreleased)" on the overview page and may assume these features aren't available yet, when in fact they have complete documentation suggesting they are released features. This creates confusion about whether users can actually use these cache backends.

Suggested fix

Either:

  1. Remove the "(unreleased)" designation if these features are actually released and available
  2. Or, if they truly are unreleased/experimental, add clear experimental/beta warnings to the individual documentation pages and explain what "unreleased" means (e.g., "available in BuildKit but not yet in stable Docker release")

The individual pages should match the status indicated in the overview.

Found by nightly documentation quality scanner

Linguagem predominante
Markdown
Estrelas
4.7k
Forks
8.5k
Merge médio
2d 11h
PRs com merge (30d)
135

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 docker/docs

Todas as issues de docker/docs

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.