corda/docs
Jonathan Locke dc179d4ea1 ENT-3057: Log hibernate warns and errors in different log (#4889)
* ENT-3057: Log hibernate warns and errors in different log

If a hibernate error occurs (deadlock, for example) that would cause a flow to be sent to the hospital, hibernate logs the warnings and errors before we do. This results in duplication in the logs, and pollutes the log. To solve this, we create a new log appender named diagnostic-{node-name}.log and log any org.hibernate messages of warn and above to that file. This way, messages are not lost, which means that the information can be retrieved if need be.

* Corrected indentation of comment (changed tab to space)

* Updated node-administration document to mention diagnostic logging change

* Fixed integration test. It was breaking because it was fetching the first log file in the folder, assuming there would be only one. This assumption is now invalid because the diagnostic log file that was introduced. Two tests were found that used similar logic to find a log file to examine, hence both were corrected to look for log files beginning with "node"

* Updated documentation as per review comments.
2019-03-18 17:08:13 +00:00
..
docs_builder do not install documentation with textlive 2019-01-30 15:33:46 +00:00
ext CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674) 2018-07-24 10:05:57 +01:00
source ENT-3057: Log hibernate warns and errors in different log (#4889) 2019-03-18 17:08:13 +00:00
.gitattributes dockerize docs building 2019-01-30 15:33:46 +00:00
.gitignore CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674) 2018-07-24 10:05:57 +01:00
build.gradle Fix documentation issues (#4721) 2019-02-06 12:49:47 +00:00
index.html Added a convenience HTML file for redirecting to the main docs. 2016-11-22 11:56:46 +00:00
install-docsite-requirements.sh Make virtualenv installable if the checkout path has whitespace. (#1187) 2017-08-18 13:31:00 +01:00
make-docsite.sh fix issue with api docs 2019-01-30 15:33:46 +00:00
Makefile [CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
packages.md [CORDA-1035] Testing api KDoc Updates (#2584) 2018-02-28 13:26:49 +00:00
README.md CORDA-2728: Add Quasar lib update step to applicataion upgrade notes (#4877) 2019-03-13 16:23:31 +00:00
requirements.txt CORDA-2350 update urllib version (#4436) 2018-12-19 07:58:08 +00:00

Corda Documentation Build

To run the Corda Documentation build run ./gradlew makeDocs

Note: In order to run the documentation build you will need Docker installed.

Windows users: If this task fails because Docker can't find make-docsite.sh, go to Settings > Shared Drives in the Docker system tray agent, make sure the relevant drive is shared, and click 'Reset credentials'.

rst style guide

It's probably worth reading this to get your head around the rst syntax we're using.