On Wed, 28 Sept 2022 at 19:12, Étienne Hossack <activ...@hossack.me> wrote: > > -1 > > Reasons to keep: > * It's useful to be able to link a specific line/method in the javadoc when > explaining something to someone through the use of a URL > * It's nice to be able to navigate the source code in your browser, if say > your IDE is having issues and you can't correctly navigate to docs via sources
The Artemis javadocs dont include the HTML source code (I recently removed it from the 5.x javadoc also via https://issues.apache.org/jira/browse/AMQ-9074). If wanting to 'browse' source code, looking at the actual code via the GitHub or gitbox UIs tends to be more useful I find. You can also link to javadoc source that way if needed. > * Often times you can read the ActiveMQ Artemis docs and think you understand > a concept, but figuring out how to actually write the code to do it is pretty > different - especially when the docs go out of date. > Javadoc can often go nearly as out of date as standalone docs too, I've lost count of the number of times I note javadocs were not properly updated to reflect a code change in a PR. If writing code using something, many will typically then have it in an IDE that then has/gets the sources (and javadoc). > In fact I'd rather the docs continue to reference the source code even more. > > If it's a lot of effort to maintain the publishing, I would reconsider for > sure my stance, but as it stands, think it's pretty useful, and when my org > isn't rate-limited on the apache website, I use them :'-) > It slows down building the site no end, publishing the site somewhat, uses a chunk of space, and adds a step to doing the release updates. The latter is perhaps why 5.x releases mostly seem to skip updating the hosted javadoc. It was missing entirely for about a year after the site content moved before anyone (a committer) noticed. It wasnt then updated for another 3 years after that, missing 5.16.x entirely, and hasnt been updated for the couple releases in the past 6 months. To be fair there probably hasnt been much change. > -- > Étienne > > On Wed, 28 Sep 2022, at 9:12 AM, Clebert Suconic wrote: > > Can we stop publishing javadocs on the ActiveMQ Website for artemis? > > > > I see no point on publishing it as they are available in Maven. > > > > My vote is to completely remove it. > > > > > > So, if you agree with me, please respond with > > > > +1 Yes, stop publishing javadocs for ActiveMQ Artemis on the website > > and keep them on maven as usual. > > > > > > > > if you have any other preferences please state a -1 and a reason for.. > > > > > > > > -- > > Clebert Suconic
