Reusing jenkins-infra/javadoc for WireMock and other projects

19 views
Skip to first unread message

Oleg Nenashev

unread,
Aug 6, 2023, 6:21:16 AM8/6/23
to Jenkins Developers
Hi all,

I am currently building a Javadoc site generator for WireMock repositories. It has a similar structure as Jenkins: a number of Java/Kotlin projects in the core, extensions and developer tooling.

One could use https://www.javadoc.io/, but the demand from the WireMock maintainers is to have a standalone hosting so that additional features could be deployed.

It would like to reuse some code from https://github.com/jenkins-infra/javadoc and have an updated version that...
  1. Takes configuration from a YAML file  (Javadoc components structure)
  2. Supports custom themes, footers and headers for the site, thgat would include the navigation bar by default
  3. Build a static site compatible with GitHub pages
  4. Include a GitHub Actions step for generation
  5. NEXT: Support for including component docs generated by non-Javadoc utilities
I think I could do these bits in a compatible way so that the same generator could be used for Jenkins and WireMock, just with a different configuration. And the Jenkins one could keep running in Jenkins as now or in Jenkinsfile Runner

Would someone else be interested in such a a reusable project?

Best regards,
Oleg
Reply all
Reply to author
Forward
0 new messages