Open fhennig opened 6 months ago
A few things worth exploring IMO:
I like these ideas. There needs to be definitely something so you can preview the docs in the operator repo in isolation with less work.
While looking into this I found this repo: https://github.com/spring-io/antora-extensions with some Antora extensions, there is one called "partial build" which might be helpful for us.
Another low hanging fruit is to not build the UI bundle on every build. especially If we want to have dedicated builds in the operators it might be nice to serve the UI bundle at a URL.
I'd rather not go back to the served bundle. That was a disaster in terms of both reproducibility and reliability (--fetch
is already more than bad enough).
That said, we should definitely cache it to avoid redundant rebuilds...
Partial/Atlas definitely looks like a good point to start looking from, yes..
Update: I tried the atlas extension: https://github.com/stackabletech/documentation/pull/574
it works, but I couldn't get partial builds to work.
I asked on the Antora Zulip chat, but didn't get a reply.
As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.
Currently the workflow is:
Main pain points are:
Links: