openhab-docs
openhab-docs copied to clipboard
openhab
Logging: Move information to one spot
Almost identical details regarding logging in rules are available in these spots:
- https://docs.openhab.org/administration/logging.html#create-log-entries-in-rules
- https://docs.openhab.org/addons/actions.html#logging-actions
- https://docs.openhab.org/configuration/rules-dsl.html#logging
This should be sorted out somehow...
How about reducing the section in the actions article to a minimum, explaining the usage in the rules article and only adding a reference to this section in the logging article?
and some (outdated info about logback) here: https://www.openhab.org/docs/developer/development/logging.html :)
maybe we need to further improve the logging.md and create sections (Logging: (1) General, (2) Addons, (3) Rules, (4) Developers) that we refer to from other docs?
wdyt @Confectrician ?
My bad.. I should have seen this Issue before I took a crack at https://github.com/openhab/openhab-docs/pull/814
No problem.. I can enhance it even further depending on the decision of the docs team
related also: https://github.com/openhab/openhab-docs/issues/593 (we can cover this in Logging: (1) General (or Intro) section
Maybe we should consolidate all Log related info in 1 place
Hey @AngelosF,
Sorry for letting you wait. This topics references a bigger change and many areas and issues. I will put it on my to do list and will have a deeper look for my opinion and ideas.
BR
Jerome
Hey @AngelosF,
I had a look at the 3 files that were initially stated above. I would leave rules-dsl as it is now. We will have some redundant information then, but the rules-dsl part is very short and on point.
I would remove the part in actions.md completely and just link to the adminitration logging section with one sentence.
New user tutorial
https://www.openhab.org/docs/tutorial/logs.html is based on a linux operating system. I would like to completely rework this one and make it based on the karaf console. Every installation comes with karaf and so it doesn't matter if a new user is running openHAB on a windows machine or on a PI with openHABian.
Logging level (#367) is something for mid-term.