testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

#1.160 aberto em 19 de jan. de 2019

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1.588 forks)batch import
help wantedresolution/acknowledgedtype/docs

Métricas do repositório

Stars
 (7.535 stars)
Métricas de merge de PR
 (Mesclagem média 2d 17h) (2 fundiu PRs em 30d)

Description

Improvement for the new mkdocs-based documentation.

I'd expect that this doesn't need to be done in one big PR; it could be several.

We need some basic docs and examples (pulled in using the codeinclude macro) for:

  • docs/modules/mockserver.md
  • docs/modules/nginx.md
  • docs/modules/pulsar.md

Guia do colaborador

Direção de pesquisa
Leia a documentação existente para módulos semelhantes (por exemplo, docs/modules/postgresql.md) e use a macro codeinclude para incluir exemplos de código das classes de teste correspondentes.
Pilha de tecnologia
java
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.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80