added docs for error reporting via GitHub #25
Conversation
krokicki
left a comment
krokicki
left a comment
There was a problem hiding this comment.
Hi @olbris ,
I added some documentation about properties and how they are configured from HortaCloud. Can you please give your new properties defaults here:
https://github.com/JaneliaSciComp/workstation/blob/4e7b5ac7eba0034a97d15e08d8e74619785c4a46/modules/Core/src/main/resources/console.properties#L84
And then expose them to HortaCloud here (I suggested some environment variable names in the documentation; feel free to change them but they need to match the docs):
https://github.com/JaneliaSciComp/jacs-cm/blob/master/containers/jacs-init/filesystem/api-gateway/client/client.properties
Finally, if you want you can add the env vars in the template file (with empty defaults):
https://github.com/JaneliaSciComp/jacs-cm/blob/master/.env.template
Thanks,
Konrad
|
|
||
| Because issues can be created automatically by the HortaCloud application, you should expect to receive _many_ repeated issues, if an issue can be triggered during a common workflow. In worst case scenarios, this can be several dozen or more issues in hours, in spite of the issue report throttling built in to HortaCoud. The rate of message generation depends on the frequency of the issue and the size of the user base. | ||
|
|
||
| Due to this repetition, it's useful to keep these automated and user issue reports in their own issue tracker separate from issues created by developers for managing their software development processes, or the one will overwhelm the other. |
|
|
||
| # Configuration | ||
|
|
||
| In the HortaCloud environment, environment variables such as those listed below are controlled through an `.env.config` file (derived from `.env.template`). See the deployment documentation for details. |
There was a problem hiding this comment.
It would need to be added to this file: https://github.com/JaneliaSciComp/jacs-cm/blob/master/containers/jacs-init/filesystem/api-gateway/client/client.properties
The documentation for this is currently very minimal. It is mentioned in the manual deployment but not for HortaCloud. I will add more and link it here.
There was a problem hiding this comment.
I've added some commits to address this.
See main pull request JaneliaSciComp/workstation#46.