Hi David & Cameleers, On Wed, Sep 8, 2021 at 4:48 PM David Jencks <[email protected]> wrote: > > > <snip> > >>>> - If nothing else is using the model building in UpdateReadmeMojo it can > >>>> probably be simplified further. > >>> > >>> From what I understand we only need the JSON files generated now, > >>> perhaps the we don't need the UpdateReadmeMojo at all any more? > >> > >> Perhaps. It still generates the doc header. If Allow asciidoctor > >> extensions when processing nav files and headers > >> <https://gitlab.com/antora/antora/-/issues/592> were implemented, the > >> header generation could be done by the jsonpath extension, but I’m not > >> sure how much of an improvement that would be. In any case, > >> UpdateReadmeMojo is now more of a sanity checker than content generator > >> :-). > > > > I kinda think that we should have a prescribed attributes that any > > document needs to be published and if there are attributes missing or > > values don't make sense then that needs to be corrected. I saw this > > work as a good way to reduce the amount of regen commits and moving > > this to a responsibility of the author. > > > > Perhaps we can change the role of the UpdateReadmeMojo (and rename > > it), to be a linter for the documentation? Any thoughts > > Claus/Andrea/others? > > If we agree it should be only a checker, the functionality could also be > implemented as an Antora pipeline extension. This would fail the site build > rather than doing something during the java build. I don’t know whether or > not this would be a good idea, but it’s a possibility :-)
I think the website build is far removed from the other projects, so by the time folk see the issue the context has already been forgotten. Especially for new contributors, contributing a new component and doc improvements, they might find it confusing that everything was built okay, but the page on the website, or even the website build is broken. zoran -- Zoran Regvart
