Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description of logback.xml property needs correcting #11

Open
kevinphippsstfc opened this issue Nov 2, 2023 · 1 comment
Open

Description of logback.xml property needs correcting #11

kevinphippsstfc opened this issue Nov 2, 2023 · 1 comment

Comments

@kevinphippsstfc
Copy link

In the installation file (installation.xhtml.vm) the description of the logback.xml property says "The file ids.logback.xml.example may be renamed to ids.logback.xml to get started” but the file is actually called logback.xml.example and can be renamed to logback.xml.

I'm not actually sure this property works. Sam Hough in Diamond had problems with the property and asked me about it which alerted me to the error in the documentation. So possibly this property needs removing from the documentation and instead have a sentence in the instructions telling you to rename the file if you want to use it.

@kevinphippsstfc
Copy link
Author

Looking into this a bit further, there is no code to handle a logback.xml property in the PropertyHandler (or anywhere else in the java code). The only place the file is handled is in the setup script where if a file named logback.xml is found then it is added to the WEB-INF/classes directory of the jar to be deployed.

Therefore I think the correct thing to do is to remove the documentation of the property in the run.properties file and add a sentence to the instructions saying to rename the file if you want to use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant