From 06cf7a21bebbcdf9d98e78ea1b13477216f2378d Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Tue, 17 May 2016 19:40:53 +0200 Subject: [PATCH] Docs: misc markup fixes and adjust an out of date paragraph about oracles. --- docs/source/index.rst | 4 ++-- docs/source/node-administration.rst | 2 +- docs/source/oracles.rst | 10 +++++----- .../{tutorial_contract.rst => tutorial-contract.rst} | 0 4 files changed, 8 insertions(+), 8 deletions(-) rename docs/source/{tutorial_contract.rst => tutorial-contract.rst} (100%) diff --git a/docs/source/index.rst b/docs/source/index.rst index c882b8145d..d09e9f6e5e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,7 +26,7 @@ Read on to learn: inthebox getting-set-up data-model - consensus + consensus messaging running-the-demos node-administration @@ -36,7 +36,7 @@ Read on to learn: :maxdepth: 2 :caption: Tutorials - tutorial_contract + tutorial-contract protocol-state-machines oracles diff --git a/docs/source/node-administration.rst b/docs/source/node-administration.rst index 5e4c75bdce..d83d75c4e1 100644 --- a/docs/source/node-administration.rst +++ b/docs/source/node-administration.rst @@ -8,7 +8,7 @@ Monitoring your node -------------------- Like most Java servers, the node exports various useful metrics and management operations via the industry-standard -`JMX infrastructure `_. JMX is a standard _in-process_ API +`JMX infrastructure `_. JMX is a standard API for registering so-called _MBeans_ ... objects whose properties and methods are intended for server management. It does not require any particular network protocol for export. So this data can be exported from the node in various ways: some monitoring systems provide a "Java Agent", which is essentially a JVM plugin that finds all the MBeans and sends diff --git a/docs/source/oracles.rst b/docs/source/oracles.rst index 5457b49fc6..2314111be5 100644 --- a/docs/source/oracles.rst +++ b/docs/source/oracles.rst @@ -176,11 +176,11 @@ Implementation involves the following steps: 2. Defining a lower level service class, that binds network messages to the API. 3. Defining a protocol using the :doc:`protocol-state-machines` framework to make it easy for a client to interact with the oracle. +4. Constructing it (when advertised) in ``AbstractNode``. An example of how to do this can be found in the ``NodeInterestRates.Oracle``, ``NodeInterestRates.Service`` and -``RateFixProtocol`` classes. The exact details of how this code works will change in future, so for now consulting -the protocols tutorial and the code for the server-side oracles implementation will have to suffice. There will be more -detail added once the platform APIs have settled down. +``RateFixProtocol`` classes. -Currently, there's no network map service, so the location and identity keys of an oracle must be distributed out of -band. \ No newline at end of file +The exact details of how this code works will change in future, so for now consulting the protocols tutorial and the +code for the server-side oracles implementation will have to suffice. There will be more detail added once the +platform APIs have settled down. \ No newline at end of file diff --git a/docs/source/tutorial_contract.rst b/docs/source/tutorial-contract.rst similarity index 100% rename from docs/source/tutorial_contract.rst rename to docs/source/tutorial-contract.rst