Documentation for Yaml/Xml configured files #868
Conversation
There was a problem hiding this comment.
Thanks!
I made some suggestions (that you should be able to apply directly via the GitHub UI), hopefully they do not introduce any error.
(Not a policy as far as I can tell, maybe it is just a preference of mine) I think it would be nice to cut long sentences over multiple lines. Usually I tend to follow something like Semantic Line Breaks. From my point of view the gain is when reviewing diffs.
|
Thanks, good improvement. I have added an additional commit introducing semantic line breaks. |
|
The first version was incorrect on some points having to do with the XML-configured files. This should hopefully be better. |
| Configuration files are searched for by name in a series of directories given as a lookup path. | ||
| This is specified either with the `--coreConfigPath` command line parameter to MXCuBE, | ||
| or through the `MXCUBE_CORE_CONFIG_PATH` environment variable. | ||
| The files live under the `mxcubecore/mxcubecore/configuration` directory, |
There was a problem hiding this comment.
Is --coreConfigPath parameter specific for MxCube-QT? I'm getting unrecognized arguments error when trying to use this with mxcubeweb:
$ ./mxcubeweb-server --coreConfigPath foo
usage: mxcubeweb-server [-h] [-r HWR_DIRECTORY] [-s STATIC_FOLDER] [-l LOG_FILE] [-L LOG_LEVEL] [-el ENABLED_LOGGER_LIST] [-w] [-t]
mxcubeweb-server: error: unrecognized arguments: --coreConfigPath foo
There was a problem hiding this comment.
Good point - I'll fix this.
There was a problem hiding this comment.
Thanks for noticing.
| Configuration files are searched for by name in a series of directories given as a lookup path. | ||
| This is specified either with the `--coreConfigPath` command line parameter to MXCuBE, | ||
| or through the `MXCUBE_CORE_CONFIG_PATH` environment variable. | ||
| The files live under the `mxcubecore/mxcubecore/configuration` directory, |
There was a problem hiding this comment.
The files live under the mxcubecore/mxcubecore/configuration directory,
Is that specific for MxCube-QT?
For the record, we keep our config files under /opt/mxcube/conf when deploing our MxCube-web.
There was a problem hiding this comment.
Yes, needs clarification.
|
Seems like we should merge this, because the latest updates seem to be code changes rather than documentation. |
|
You are right. I was waiting for @oldfielj-ansto, but it is time now. Merging. |
No description provided.