testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Open

#1 160 ouverte le 19 janv. 2019

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Java (1 588 forks)batch import
help wantedresolution/acknowledgedtype/docs

Métriques du dépôt

Stars
 (7 535 stars)
Métriques de merge PR
 (Merge moyen 2j 17h) (2 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Lisez la documentation existante pour des modules similaires (par exemple, docs/modules/postgresql.md) et utilisez la macro codeinclude pour inclure des exemples de code à partir des classes de test correspondantes.
Stack technique
java
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80