wiremock / wiremock/wiremock.org

Add versioning to WireMock documentation

Open
#37 2 comments 1 reaction 1 assignee View on GitHub

@oleg-nenashev is already working on this.

Since Apr 30, 2023.

community documentation
Dominant language
HTML
Stars
12
Forks
71
PR merge metrics
No merged PRs in 30d

Description

Proposal

Currently, WireMock documentation does not include complete (or even approaching complete) information about when features were implemented to WireMock. Users can often struggle to properly implement features, simply because they're using a lower version of WireMock than the feature they'd like to use. (For example, what version of WireMock introduced logical AND and OR?) Having minimum versions alongside feature documentation could help ease this struggle.

Admittedly, with the impending release of WireMock 3.0+, this may all be a moot point, if the idea is just that "everything was released in 3.0.0", but it could still be useful to "reset" everything to that, and document when new features are added.

Scope
  • Add 3.x to the documentation, without duplicating content - https://github.com/wiremock/wiremock.org/issues/53
  • Add navigation helpers in doc headers to help others with finding 2.x and 3.x docs
  • Add documentation page describing WireMock Java baselines and providing disclaimers for other components
  • Figure out something for pages relocation
  • Add WireMock 3 preview announcement
Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.