wiremock/wiremock.org

EPIC: Restructure the examples to use code tabs

Open

#183 opened on Sep 28, 2023

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)HTML (72 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (12 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Find sequential JSON and Java examples in WireMock documentation, merge them into a single code tabs block using the {codetabs} macro, and copy edit surrounding text.
Tech stack
html
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70