Re: [Website] Better error checking
The level of details for the website build is great. Especially I like that the log shows 'refname'. I'm always confused to see warns even if I fix up the main branch. On Tue, Aug 17, 2021 at 8:27 PM Claus Ibsen wrote: > Hi > > Oh that is great to see more detailed WARN / ERROR as today we get too > limited information so its almost a needle in the haystack where the > problem really is. > And you have to hunt across the sub projects and their docs as well to > find it. > > At least the file name as above will be a great pointer to find the > problem. > > On Tue, Aug 17, 2021 at 7:53 AM David Jencks > wrote: > > > > Related to my proposal to change how component pages are (partially) > generated I expect to be proposing to move to the latest Antora 3 alpha. > In particular this has logging and the ability to be configured to fail on > log levels, in particular warnings. This will make the xref-checker > obsolete, as logging provides more detailed information. > > > > Currently the warnings and errors from the build are: > > > > [22:44:07.521] WARN (asciidoctor): skipping reference to missing > attribute: myclient > > file: docs/user-manual/modules/ROOT/pages/route-template.adoc > > source: https://github.com/apache/camel.git (refname: main, start > path: docs/user-manual) > > [22:44:07.524] WARN (asciidoctor): skipping reference to missing > attribute: myclient > > file: docs/user-manual/modules/ROOT/pages/route-template.adoc > > source: https://github.com/apache/camel.git (refname: main, start > path: docs/user-manual) > > [22:44:29.764] WARN (asciidoctor): skipping reference to missing > attribute: body > > file: docs/components/modules/languages/pages/simple-language.adoc > > source: https://github.com/apache/camel.git (refname: camel-3.11.x, > start path: docs/components) > > [22:45:12.893] WARN (asciidoctor): skipping reference to missing > attribute: body > > file: docs/components/modules/languages/pages/simple-language.adoc > > source: https://github.com/apache/camel.git (refname: main, start > path: docs/components) > > [22:45:47.775] WARN (asciidoctor): skipping reference to missing > attribute: 8 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 12 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 8 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.776] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 3 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 12 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 8 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 4 > > file: docs/modules/ROOT/pages/apis/crds-html.adoc > > source: https://github.com/apache/camel-k.git (refname: main, start > path: docs) > > [22:45:47.777] WARN (asciidoctor): skipping reference to missing > attribute: 3 > > file:
Re: [Website] Better error checking
Hi Oh that is great to see more detailed WARN / ERROR as today we get too limited information so its almost a needle in the haystack where the problem really is. And you have to hunt across the sub projects and their docs as well to find it. At least the file name as above will be a great pointer to find the problem. On Tue, Aug 17, 2021 at 7:53 AM David Jencks wrote: > > Related to my proposal to change how component pages are (partially) > generated I expect to be proposing to move to the latest Antora 3 alpha. In > particular this has logging and the ability to be configured to fail on log > levels, in particular warnings. This will make the xref-checker obsolete, as > logging provides more detailed information. > > Currently the warnings and errors from the build are: > > [22:44:07.521] WARN (asciidoctor): skipping reference to missing attribute: > myclient > file: docs/user-manual/modules/ROOT/pages/route-template.adoc > source: https://github.com/apache/camel.git (refname: main, start path: > docs/user-manual) > [22:44:07.524] WARN (asciidoctor): skipping reference to missing attribute: > myclient > file: docs/user-manual/modules/ROOT/pages/route-template.adoc > source: https://github.com/apache/camel.git (refname: main, start path: > docs/user-manual) > [22:44:29.764] WARN (asciidoctor): skipping reference to missing attribute: > body > file: docs/components/modules/languages/pages/simple-language.adoc > source: https://github.com/apache/camel.git (refname: camel-3.11.x, start > path: docs/components) > [22:45:12.893] WARN (asciidoctor): skipping reference to missing attribute: > body > file: docs/components/modules/languages/pages/simple-language.adoc > source: https://github.com/apache/camel.git (refname: main, start path: > docs/components) > [22:45:47.775] WARN (asciidoctor): skipping reference to missing attribute: 8 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 12 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 8 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 12 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 8 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 4 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) > [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 > file: docs/modules/ROOT/pages/apis/crds-html.adoc > source: https://github.com/apache/camel-k.git (refname: main, start path: > docs) >
Re: [Website] Better error checking
Hi David, On Tue, Aug 17, 2021 at 7:53 AM David Jencks wrote: > > Related to my proposal to change how component pages are (partially) > generated I expect to be proposing to move to the latest Antora 3 alpha. In > particular this has logging and the ability to be configured to fail on log > levels, in particular warnings. This will make the xref-checker obsolete, as > logging provides more detailed information. +1 for replacing the xref-checker, we basically generate the Antora portion of the website twice, which takes up quite a bit of time; so removing the xref-checker should speedup the build. > Currently the warnings and errors from the build are: > > [22:44:07.521] WARN (asciidoctor): skipping reference to missing attribute: > myclient > file: docs/user-manual/modules/ROOT/pages/route-template.adoc > source: https://github.com/apache/camel.git (refname: main, start path: > docs/user-manual) [snip] > Currently this sort of warning is output to the console but cannot be used to > fail the build. Could we use `failure_level`[1] to fail the build? I'm taking it as a fact that most folk don't go through the build logs so not failing the build for errors (and we should fail for warnings as well IMHO) leaves us with a broken website. zoran [1] https://docs.antora.org/antora/3.0/playbook/runtime-log-failure-level/ -- Zoran Regvart
[Website] Better error checking
Related to my proposal to change how component pages are (partially) generated I expect to be proposing to move to the latest Antora 3 alpha. In particular this has logging and the ability to be configured to fail on log levels, in particular warnings. This will make the xref-checker obsolete, as logging provides more detailed information. Currently the warnings and errors from the build are: [22:44:07.521] WARN (asciidoctor): skipping reference to missing attribute: myclient file: docs/user-manual/modules/ROOT/pages/route-template.adoc source: https://github.com/apache/camel.git (refname: main, start path: docs/user-manual) [22:44:07.524] WARN (asciidoctor): skipping reference to missing attribute: myclient file: docs/user-manual/modules/ROOT/pages/route-template.adoc source: https://github.com/apache/camel.git (refname: main, start path: docs/user-manual) [22:44:29.764] WARN (asciidoctor): skipping reference to missing attribute: body file: docs/components/modules/languages/pages/simple-language.adoc source: https://github.com/apache/camel.git (refname: camel-3.11.x, start path: docs/components) [22:45:12.893] WARN (asciidoctor): skipping reference to missing attribute: body file: docs/components/modules/languages/pages/simple-language.adoc source: https://github.com/apache/camel.git (refname: main, start path: docs/components) [22:45:47.775] WARN (asciidoctor): skipping reference to missing attribute: 8 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 12 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 8 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.776] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 12 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 8 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 4 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 3 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 12 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 8 file: docs/modules/ROOT/pages/apis/crds-html.adoc source: https://github.com/apache/camel-k.git (refname: main, start path: docs) [22:45:47.777] WARN (asciidoctor): skipping reference to missing attribute: 4 file:
