wiremock / wiremock/wiremock-docker
Move documentation to the project's repository
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 240
- Forks
- 108
- PR merge metrics
- No merged PRs in 30d
Description
Summary
Currently we have duplication of docs between README and the project's website, and I doubt it would be good in the future. To avoid consistency issues, I would propose to follow the documentation-as-code approach and put all the image-specific documentation under the repository, and just have a bare minimum on the website. Later we can implmenet importing documentation from the repository to the website.
References
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the repository README with the referenced https://wiremock.org/docs/docker/ page to inventory duplicated image-specific documentation. Start by identifying where documentation currently lives in the repository; done means the image-specific content is maintained there and the website is reduced to a bare minimum. The proposed later import from the repository is described as future work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100