openSUSE / docserv

A server for building and publishing documentation with DAPS
https://opensuse.github.io/docserv/
GNU General Public License v3.0
4 stars 3 forks source link

Schema changes for 7.0 (i.e. next major) release #283

Open ghost opened 2 years ago

ghost commented 2 years ago

Christoph criticized some of the element names we are currently using in the product config. This updates the config file format.

Both changes are entirely untested currently.

tomschr commented 2 years ago

Thanks Stefan! :hugs: This is all nice and cool and I really appreciate your contribution, but it's your free time and you should relax, not work. :slightly_smiling_face:

To be honest, it looks like a disruptive change to me. Our configs currently use the old name (although this is a minor thing and could be changed). But the main part is that I feel a bit uneasy as our main developer isn't on board anymore.

I'm also not feeling good about such a change as it makes docserv a moving target (again). We don't have any test cases which could help us to justify that all is good and tested. What if we miss some corner cases? Forget about some things? Small changes could bring big issues. I'm not as confident in the current code base as you. If anything goes wrong we can't publish! Unfortunately, you can't be here to fix it and we can't request that.

These are all reasons for me to be very hesitant about merging this PR. Maybe I completely miss something. Sorry if I see it as too risky.

We can leave it open for the time being and see what the future will bring to our workflow. Maybe after I'm being more confident about the hole docserv workflow (or Franks asks me to maintain it) we can reconsider it.

ghost commented 2 years ago

To be honest, it looks like a disruptive change to me.

Yes, it is :) Which is why this is a PR and not merged.

I'm also not feeling good about such a change as it makes docserv a moving target (again). We don't have any test cases which could help us to justify that all is good and tested. What if we miss some corner cases? Forget about some things?

Of course it needs to be tested a bit. But there's no need to be overly scared of the change. When it's rolled out, the production config needs to be updated a little, but that is straightforward as well.