On Wed, Jan 22, 2025 at 8:00 AM Gilles Sadowski <gillese...@gmail.com> wrote: > > Hi. > > Le mer. 22 janv. 2025 à 13:12, Gary Gregory <garydgreg...@gmail.com> a écrit : > > > > It's unclear to me if we need the PMC's approval for this. We > > certainly did not vote on it.
Well, I certainly would like to know exactly what is proposed here. Does this affect one component, all components, if not all components, which components? > > Well, this thread is meant to gather opinions about this. > No need to vote if there is a clear argument, one way or > the other. > > > It just looks like busy work to me for > > little to no gain. > > For one, the caveat[1] when a release candidate is being > put to the vote that says something equivalent to "some > parts of the site don't work, but all will be fine (at some point > in the future)" is something that's worth fixing IMHO. I think the only site link that doesn't work is the download*.cgi link. Do you know of other links? > > Also, you mentioned one path of progress, that is (IIUC) for > the web site contents to be the aggregation of the > components' Javadoc-generated files. I did not mention this in this conversation. Still, years ago I did mention somewhere that it would be nice to have a Javadoc site for all of Commons in addition to the Javadocs for individual components, especially considering Javadoc's search box feature. What I did mention last week is the desire to migrate a component's documentation from its site into its Javadoc, like Apache Juneau and Commons BeanUtils. > So somewhere (in which "...-plugin"?), code would generate > a "staged" website (from the release candidate functional > and easily comparable to the "live" one. > > Refactoring is not just about moving things or updating the > CSS (or equivalent) style sheet. > It could potentially lead to new functionality to be potentially > more easily added, e.g. a "search box" whose results would > point to the relevant parts of the Javadoc (just an idea; I've > no clue how to do that). Javadoc sites include a search box, which is nice but only matches type and method names IIRC. Gary > > The web site is for _users_. The current one offers barely > any added value (over reading the source in a pager). > [By far, the most time I spent looking at it was while preparing > a release candidate. And even then it was mostly to look at > reports, whose contents could as well have been collected > in a bunch of ASCII files. Users are mostly not really > interested in reports (like RAT, source code management, > Junit, Jacoco, CheckStyle, SpotBugs, PMD, CPD), only > people who check the release candidate are.] > > Regards, > Gilles > > [1] That existed for as long as I've been here. > > >> [...] > > --------------------------------------------------------------------- > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org > For additional commands, e-mail: dev-h...@commons.apache.org > --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org For additional commands, e-mail: dev-h...@commons.apache.org
