a477d59c15
- Handle errors in Jackson and checkpoint deserialisation. A file notifying the user that the checkpoint dump failed is created when errors occur. - Handle message deserialisation errors. A string placeholder is used if an error occurs. - Add more information about subflows (include their `FlowLogic`) - Increase clarity in checkpoint output field names * CORDA-3904 Add `flowCallStackSummary` Add `flowCallStackSummary` to the output which contains the same content as `flowCallStack` minus each subflow's `FlowLogic`. The `FlowLogic` contains a ton of info which is normally repeated in each subflow. Adding the summary gives an overview of the steps the flow executed and which step it is currently on. The `suspendedOn` field is put underneath the summary and the original call stack is moved below the suspended info. This puts the most useful information towards the top of the json file.
Corda Documentation Build
This Readme describes how to build the Corda documentation for the current version. The output html files will be written to the corda\docs\build\html directory.
Prerequisites / First time build
Before you begin, you need to:
- Install Docker.
- Ensure that Docker is running.
- Select Expose daemon on tcp://localhost:2375 without TLS in the Docker Settings (which you can open from the System Tray by right-clicking the Docker symbol and then selecting Settings)
Build process
- Open a cmd dialogue.
- Navigate to the root location (this is the
\cordadirectory) - Run the documentation build (
gradlew makeDocsor./gradlew makeDocs)
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
The Corda documentation is described using the ReStructured Text (RST) markup language. For details of the syntax, see this.
Version placeholders
We currently support the following placeholders; they get substituted with the correct value at build time:
"|corda_version|"
"|java_version|"
"|kotlin_version|"
"|gradle_plugins_version|"
"|quasar_version|"
If you put one of these in an rst file anywhere (including in a code tag), it will be substituted with the value from constants.properties
(which is in the root of the project) at build time.
The code for this can be found near the top of the conf.py file in the docs/source directory.