I’ve proposed a couple of PRs that do fix the website build and expose some info on this new springdoc thing, but I have no way to know how appropriate my new page is.
https://github.com/apache/camel/pull/6375 https://github.com/apache/camel-spring-boot/pull/403 I’d suggest we apply the PRs and then improve the documentation. David Jencks > On Nov 3, 2021, at 10:15 AM, David Jencks <[email protected]> wrote: > > Why does eaf68b5767c827d3b463b061a6e8aebc062cce46 add this file? > > docs/components/modules/spring-boot/partials/openapi-java-starter.adoc > > Obviously I need to document better how the spring-boot docs work now. Where? > > The source adoc file shouldn’t exist either: where did it come from? > > Running the build locally I see on > documentation/camel-spring-boot/next/list.html#_unused_spring_boot_starter_names: > > UNUSED SPRING-BOOT-STARTER NAMES > springdoc > <x-msg://53/#_camel_spring_boot> > That means there is no main camel component adoc page referencing this > starter, so it won’t show up anywhere in the documentation. > > Indeed, there’s no springdoc component project, and the c-s-b pom hints it’s > an offshoot of the openapi-java component. > > I suspect the proper solution is to add a > components/camel-openapi-java/src/main/docs/camel-springdoc.adoc file with > > //Manually maintained attributes > :camel-spring-boot-name: springdoc > > in the header attributes and > > include::spring-boot:partial$starter.adoc[] > at the end. > > This whole experience indicates that the system I put in place works great > and that it isn’t documented enough. > > I guess adding instructions that appear when there’s a problem would be a > good place to start, but I don’t know how to get someone to look at that page. > > Running the site build locally I also see a ton of problems with camel-k and > kamelets that I haven’t looked at yet. > > For me the biggest problem is that I don’t see any notifications that the > website build is broken, and even if I do extracting the problem from the > build info is quite difficult. > > David Jencks > >> On Nov 3, 2021, at 6:48 AM, David Jencks <[email protected] >> <mailto:[email protected]>> wrote: >> >> Maybe the copying isn’t configured quite right or the results of running it >> weren’t committed? IIRC it’s in the docs pom. I can investigate in a few >> hours. >> >> David Jencks >> >>> On Nov 3, 2021, at 6:43 AM, Claus Ibsen <[email protected] >>> <mailto:[email protected]>> wrote: >>> >>> Hi >>> >>> There is a new spring-boot module called camel-springdoc-starter which >>> could be the cause of this. >>> >>> I checked which -starter has .adoc files and its only >>> >>> ~/workspace/camel-spring-boot/components-starter main ❯ find . -name >>> '*.adoc' >>> ./camel-springdoc-starter/src/main/docs/springdoc-starter.adoc >>> ./camel-openapi-java-starter/src/main/docs/openapi-java-starter.adoc >>> >>> And then in the docs folder, then it is only one of them there is >>> located there. Maybe the file (springdoc-starter.adoc) must be >>> manually copied over there or something? >>> >>> ~/workspace/camel-spring-boot/docs main ❯ find . -name '*.adoc' >>> ./components/modules/spring-boot/partials/openapi-java-starter.adoc >>> ./components/modules/spring-boot/partials/starter.adoc >>> ./spring-boot/modules/ROOT/nav.adoc >>> ./spring-boot/modules/ROOT/pages/spring-boot-xml.adoc >>> ./spring-boot/modules/ROOT/pages/list.adoc >>> ./spring-boot/modules/ROOT/pages/spring-boot.adoc >>> ./spring-boot/modules/ROOT/pages/index.adoc >>> >>> On Wed, Nov 3, 2021 at 2:31 PM David Jencks <[email protected] >>> <mailto:[email protected]>> wrote: >>>> >>>> Please don’t remove that include, it’s there to tell you that someone made >>>> the camel spring boot system inconsistent. The inconsistency is that >>>> there’s a .json file for a starter with no corresponding documentation >>>> page. If you build the site locally and look at the spring boot index >>>> page you’ll see what it is. If you can access the build results that >>>> failed you can see it there, but I don’t know how to do that. >>>> >>>> Where would be a good place to document how this works? >>>> >>>> David Jencks >>>> >>>> >>>> >>>>> On Nov 3, 2021, at 4:23 AM, Zoran Regvart <[email protected] >>>>> <mailto:[email protected]>> wrote: >>>>> >>>>> Hi Cameleers, >>>>> The website has been broken for a few days now. One issue[1] reported >>>>> by Claus was fixed by making sure that the Yarn cache is appropriate >>>>> for the Docker/Linux build we perform on ci-builds.a.o. >>>>> >>>>> Now that issue seems to be resolved, but another issue occurred, and I >>>>> can't really understand why, the `yarn workspaces foreach` seems to >>>>> ignore the top-level workspace, and only the Antora UI is built. >>>>> >>>>> This issue seems to be resolved by upgrading Yarn & plugins, which I >>>>> have prepared in a draft pull request[2], but that is now blocked by >>>>> an error in the build traced back to a pull request[3] in >>>>> camel-spring-boot. >>>>> >>>>> I'm not sure if I should outright remove that include, or if it serves >>>>> a specific purpose that I don't understand yet. >>>>> >>>>> Can someone help me with this? David? >>>>> >>>>> zoran >>>>> >>>>> [1] https://github.com/apache/camel-website/issues/660 >>>>> <https://github.com/apache/camel-website/issues/660> >>>>> [2] https://github.com/apache/camel-website/pull/646 >>>>> <https://github.com/apache/camel-website/pull/646> >>>>> [3] https://github.com/apache/camel-spring-boot/pull/391 >>>>> <https://github.com/apache/camel-spring-boot/pull/391> >>>>> -- >>>>> Zoran Regvart >>>> >>> >>> >>> -- >>> Claus Ibsen >>> ----------------- >>> http://davsclaus.com <http://davsclaus.com/> @davsclaus >>> Camel in Action 2: https://www.manning.com/ibsen2 >>> <https://www.manning.com/ibsen2> >> >
