wiremock / wiremock/wiremock.org
Host Javadoc under the official website
Open
Nobody has claimed this yet.
documentation
enhancement
- Dominant language
- HTML
- Stars
- 12
- Forks
- 71
- PR merge metrics
- No merged PRs in 30d
Description
Proposal
As @tomakehurst mentioned in https://github.com/wiremock/community/pull/26, we should rather self-host Javadoc if we find it important. Most likely, it could be a documentation website on the javadoc.wiremock.org subdomain serving docs for our components
References
- Unofficial Docs site: https://javadoc.io/doc/com.github.tomakehurst/wiremock
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
Start by reading the proposal and the referenced community pull request 26, then compare the unofficial Javadoc site at javadoc.io with the WireMock website repository. Define how Javadoc would be hosted under javadoc.wiremock.org and what website or publishing changes are required; done means the component documentation is served from that official subdomain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100