testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

#1160 aperta il 19 gen 2019

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Java (1588 fork)batch import
help wantedresolution/acknowledgedtype/docs

Metriche repository

Star
 (7535 star)
Metriche merge PR
 (Merge medio 2g 17h) (2 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Leggi la documentazione esistente per moduli simili (es. docs/modules/postgresql.md) e utilizza la macro codeinclude per includere esempi di codice dalle corrispondenti classi di test.
Tech stack
java
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80