Define omero.qa.feedback as new visible server property #38
Conversation
| ## QA configuration | ||
| ############################################# | ||
| # Base URL to use when sending feedback (errors, comments) | ||
| omero.qa.feedback=http://qa.openmicroscopy.org.uk |
There was a problem hiding this comment.
I haven't read through the rest of the PR, but in terms of symmetry "omero.feedback.url" rings truer for me.
There was a problem hiding this comment.
we have omero.upgrades.url so omero.feedback.url or omero.qa.url will make sense
There was a problem hiding this comment.
Interesting thoughts. I went for the minimal amount of changes/extra configuration but happy to update to use a different property name if we reach a consensus.
After a bit of research, a few comments on QA vs feedback:
OMERO.qais the historical name of the OME application which was built to receive the feedback from clients and handle upgrade checks - see https://omero.readthedocs.io/en/stable/users/history.html#beta-4-1-october-2009 for the original announcement- code-wise, the
omero_qanamespace is primarily used internally within the app - the only relevant usage in the OMERO stack is the internal
omero.qa.feedbackOMERO.web property - OMERO.web has some
omero.web.feedback.*settings allow to turn on/off part of the feedback mechanism - if we decided to go for
omero.feedback.url, I suspect we would eventually try to deprecateomero.qa.feedbackand update the client to consumeomero.feedback.url
There was a problem hiding this comment.
Thanks for that summary, @sbesson. The fact that it's also documentation in sysadmin/config.rst leads me to say let's not change it. (At least in terms of the naming, I feel somewhat vindicated by the environment variable in https://github.com/ome/omero-web/blob/3ae446b01d98493b109998c1dece8224337db54a/omeroweb/settings.py#L267 😄)
Similarly to omero.upgrades.url this allows connected clients to consume the URL defined server-side and direct QA feedback accordingly
There was a problem hiding this comment.
Read and makes sense to me, thank you - the naming discussion seems a bit inconclusive, but it seems that @jburel is happy with what is now in this PR, and thus so am I. I guess the eventual renaming would be done in other PRs/repos.
Similarly to
omero.upgrades.url, this property allows connected clients to access the server configuration and direct QA feedback accordingly.At the moment, OMERO.web is the main client which defines a similar mechanism in https://github.com/ome/omero-web/blob/master/omeroweb/settings.py#L267
The name and default value of the server property are kept identical to the ones in the OMERO.web setting. Practically, a combined OMERO.server/OMERO.web deployment overriding the default value of
omero.qa.feedbackto use an alternate QA endpoint, there should be no configuration change and other clients can start retrieving the value ofomero.qa.feedbackand using it internally.Initially, the primary target of this work will be OMERO.insight (a companion PR will be opened shortly). The importer is another client that could be updated in the mid-term to use the new configuration.