wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

Offen

#183 geöffnet am 28.09.2023

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (72 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (12 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Proposal

In WireMock documentation, there are A LOT of examples where JSON and Code examples are placed in separate examples which takes a lot of vertical space and complicates the documentation. Instead of that, it would be nice if the examples were put into recently introduced Code Tabs like this one:

image

Steps

Each case can be submitted as a separate pull request:

  • Find a case when two examples (usually JSON and Java) are placed sequentially
  • Merge examples into a single block using the {codetabs} macro
  • Copy-edit text around examples to ensure it is consistent

Example of a patch: https://github.com/wiremock/wiremock.org/pull/165

References

No response

Contributor Guide

Research-Richtung
Finden Sie aufeinanderfolgende JSON und Java Beispiele in der WireMock Dokumentation, fassen Sie sie mit dem {codetabs} Makro in einem einzigen Code Tab Block zusammen und bearbeiten Sie den umgebenden Text.
Tech Stack
html
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-2 Tage
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.
70