Publish Javadoc #3031
Description
🤔 What's the problem you're trying to solve?
Cucumber has quite a bit of Javadoc with technical information. But it is not published anywhere. This makes it hard to reference this information and leads to duplication.
✨ What's your proposed solution?
Publish the documentation on https://cucumber.io.
Desired:
- Publish the Javadoc for Cucumber JVM to both versioned and latest pages. E.g.
docs/1.2.3/anddocs/latest.
Optional:
- Publish the Javadoc for other Java projects.
⛏ Have you considered any alternatives or workarounds?
-
There are sites that download the Javadoc from Maven Central and make it available for viewing. We used those in the past, but as a free service their stability is not guaranteed.
-
Most IDE's support downloading sources and viewing Javadoc. People seem to have gotten by with this for a long time.
📚 Any additional context?
I'm not quite sure how to set this all up yet. Perhaps we can publish to Github pages and redirect the website? It would be useful to investigate how JUnit has done this.