wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

Aperta

#183 aperta il 28 set 2023

Vedi su GitHubGuida contributor
 (6 commenti) (0 reazioni) (0 assegnatari)HTML (72 fork)auto 404
documentationenhancementgood first issue

Metriche repository

Star
 (12 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Trova esempi JSON e Java sequenziali nella documentazione di WireMock, uniscili in un singolo blocco di schede di codice utilizzando la macro {codetabs} e modifica il testo circostante.
Tech stack
html
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-2 giorni
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.
70