wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

Ouverte

#183 ouverte le 28 sept. 2023

Voir sur GitHubGuide contributeur
 (6 commentaires) (0 réaction) (0 personne assignée)HTML (72 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (12 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Trouvez des exemples JSON et Java séquentiels dans la documentation WireMock, fusionnez les en un seul bloc d'onglets de code à l'aide de la macro {codetabs} et éditez le texte environnant.
Stack technique
html
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-2 jours
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.
70