testcontainers/testcontainers-java

New docs: minimal docs for modules that lack them

Offen

#1.160 geöffnet am 19.01.2019

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Java (1.588 Forks)batch import
help wantedresolution/acknowledgedtype/docs

Repository-Metriken

Stars
 (7.535 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 17h) (2 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Lesen Sie die vorhandene Dokumentation für ähnliche Module (z. B. docs/modules/postgresql.md) und verwenden Sie das Makro codeinclude, um Codebeispiele aus den entsprechenden Testklassen einzufügen.
Tech Stack
java
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80