Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

CRD doc generation leads to bad formatting

Aberta
  • Algo errado?
#702 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
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
42/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
kubernetes
Domínio
documentation

Direção de pesquisa

Comece pela seção renderizada do CRD do NiFi na URL vinculada crds.stackable.tech e identifique como a documentação de Quantity é produzida. Rastreie essa entrada pelo fluxo de geração da documentação e, em seguida, verifique se os campos Quantity afetados são renderizados sem a formatação incorreta na documentação CRD gerada.

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

Descrição

E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).

Image

Possible fixes:

  • We can try to remove that doc comment from rendering
Linguagem predominante
CSS
Estrelas
13
Forks
14
Merge médio
1d 13h
PRs com merge (30d)
29

Preparar o ambiente

  • Sem Dockerfile nem arquivo Docker Compose
  • Tem um modelo de pull request
  • Sem guia de contribuição

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 stackabletech/documentation

Todas as issues de stackabletech/documentation

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.