Hi Willes, It’s great to see someone interested in improving the state of the documentation!
Earlier this year I spent a lot of time working on a proposal to move the TomEE documentation to an Antora based structure. I didn’t get much response from the community and left it for a while, but am considering working on it some more. I think structurally the work is pretty much done but there are a bunch of, basically, presentation issues that could use improvement. If this is adopted it’s likely to make many or most earlier doc issues somewhat obsolete. The last prototype site I came up with is at https://tomee-preview.s3-us-west-2.amazonaws.com/tomee/8.0/docs.html <https://tomee-preview.s3-us-west-2.amazonaws.com/tomee/8.0/docs.html>. Having some help with this would be great. With regard to the issue you mention here, here are my thoughts: - I don’t understand why the custom code is used to assemble the unified javadoc jar. I think the maven javadoc plugin can be configured to do it. - I thought the asciidoclet plugin was already configured, but it won’t do anything until someone writes some javadoc using asciidoc :-) - I’m not quite sure what David Blevins means by an index, but it might be trivial for the Antora built site. - 4 is done - Links from javadoc to actual class usage is a great idea, but how to do it is not so obvious. I left a small comment on the sub-task. Anyway, Welcome!! David Jencks > On Jun 27, 2020, at 10:15 PM, Willes Reis <[email protected]> wrote: > > Hi David Blevins, > > Looking at the JIRA issue https://issues.apache.org/jira/browse/TOMEE-2341 on > which you are the reporter, I realized that there are 5 sub-tasks (2 closed > / 3 open) and I would like to help with something in this, but I don't know > if the proposal is still valid? If ok, could you please explain the > expectations? > > Any feedback is appreciated. > > Best regards and stay healthy! > Willes Reis
