Misc doc markup and TODO fixes.

This commit is contained in:
Mike Hearn 2016-11-23 13:25:44 +01:00
parent 22198c06b5
commit 3bec44cd65
11 changed files with 19 additions and 20 deletions

@ -673,7 +673,7 @@ copy of the code can be deleted.
Whilst kind of ugly, this is a very simple approach that should suffice for now.
.. warning:: Flows are not meant to live for months or years, and by implication they are not meant to implement entire deal
lifecycles. For instance, implementing the entire life cycle of an interest rate swap as a single flow - whilst
lifecycles. For instance, implementing the entire life cycle of an interest rate swap as a single flow - whilst
technically possible - would not be a good idea. The platform provides a job scheduler tool that can invoke
flows for this reason (see ":doc:`event-scheduling`")

@ -1,6 +1,5 @@
Further Comments on Kotlin
--------------------------
Further notes on Kotlin
-----------------------
Corda is written in a language called `Kotlin <https://kotlinlang.org/>`_. Kotlin is a language that targets the JVM
and can be thought of as a simpler Scala, with much better Java interop. It is developed by and has commercial support
@ -12,5 +11,4 @@ a few minutes of introduction. Additionally, at R3, we find that all of our deve
in Kotlin within their first week.
Due to the seamless Java interop the use of Kotlin to extend the platform is *not* required and the tutorial shows how
to write contracts in both Kotlin and Java. You can `read more about why Kotlin is a potentially strong successor to Java here <https://medium.com/@octskyward/why-kotlin-is-my-next-programming-language-c25c001e26e3>`_.
to write contracts in both Kotlin and Java. You can `read more about why Kotlin is a potentially strong successor to Java here <https://medium.com/@octskyward/why-kotlin-is-my-next-programming-language-c25c001e26e3>`_.

@ -1,7 +1,6 @@
Getting Set Up : Faultfinding
=============================
IntelliJ issues
---------------

@ -55,11 +55,13 @@ are performing (details expounded later). Whenever prompted about gradle, accept
Corda Source Code
-----------------
(TODO - when the location has been confirmed)
You can check out the Corda platform source code from this repository:
Ensure that you have access to R3 git repository.
https://github.com/corda/corda.git
https://TODO/corda-core.git
and a template app that you can use as a basis for experimenting with app development from:
https://github.com/corda/cordapp-template.git
You can catch up with the latest code by selecting "VCS -> Update Project" in the IntelliJ menu.

@ -40,7 +40,7 @@ Process steps
Preliminaries
- Ensure that there are a number of live trades with another party financial products that are covered under the
ISDA SIMM agreement (if none, then use the demo to enter some simple trades as described below).
ISDA SIMM agreement (if none, then use the demo to enter some simple trades as described below).
Initial Margin Agreement Process
- Agree that one will be performing the margining calculation against a portfolio of trades with another party, and agree the trades in that portfolio. In practice, one node will start the flow but it does not matter which node does.

@ -21,7 +21,7 @@ The JDBC URL is printed during node startup to the log and will typically look l
``jdbc:h2:tcp://192.168.0.31:31339/node``
The username and password can be altered in the :doc:`corda-config-files` but default to username "sa" and a blank
The username and password can be altered in the :doc:`corda-configuration-files` but default to username "sa" and a blank
password.
Any database browsing tool that supports JDBC can be used, but if you have IntelliJ Ultimate edition then there is

@ -37,6 +37,7 @@ Login
User can login to any Corda node using the explorer, alternately, `gradlew explorer:runDemoNodes` can be used to start up demo nodes for testing.
Corda node address, username and password are required for login, the address is defaulted to localhost:0 if leave blank.
Username and password can be configured in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``.
.. note:: If you are connecting to the demo nodes, only Alice and Bob (20004, 20006) are accessible using user1 credential, you won't be able to connect to the notary.
.. image:: resources/explorer/login.png

@ -21,7 +21,7 @@ Schemas
Every ``ContractState`` can implement the ``QueryableState`` interface if it wishes to be inserted into the node's local
database and accessible using SQL.
.. literalinclude:: ../../core/src/main/kotlin/net.corda.core/schemas/PersistentTypes.kt
.. literalinclude:: ../../core/src/main/kotlin/net/corda/core/schemas/PersistentTypes.kt
:language: kotlin
:start-after: DOCSTART QueryableState
:end-before: DOCEND QueryableState
@ -34,12 +34,12 @@ cases where the schema has evolved, with each one being represented by a ``Mappe
Nodes have an internal ``SchemaService`` which decides what to persist and what not by selecting the ``MappedSchema``
to use.
.. literalinclude:: ../../node/src/main/kotlin/net.corda.node/services/api/SchemaService.kt
.. literalinclude:: ../../node/src/main/kotlin/net/corda/node/services/api/SchemaService.kt
:language: kotlin
:start-after: DOCSTART SchemaService
:end-before: DOCEND SchemaService
.. literalinclude:: ../../core/src/main/kotlin/net.corda.core/schemas/PersistentTypes.kt
.. literalinclude:: ../../core/src/main/kotlin/net/corda/core/schemas/PersistentTypes.kt
:language: kotlin
:start-after: DOCSTART MappedSchema
:end-before: DOCEND MappedSchema
@ -85,5 +85,5 @@ to initialise the ORM layer.
Several examples of entities and mappings are provided in the codebase, including ``Cash.State`` and
``CommercialPaper.State``. For example, here's the first version of the cash schema.
.. literalinclude:: ../../finance/src/main/kotlin/net.corda.schemas/CashSchemaV1.kt
.. literalinclude:: ../../finance/src/main/kotlin/net/corda/schemas/CashSchemaV1.kt
:language: kotlin

@ -106,7 +106,7 @@ message "File received - we're happy!" should be printed.
SIMM and Portfolio Demo
-----------------------
.. note:: Read more about this demo at :doc:`initialmarginagreement`.
.. note:: Read more about this demo at :doc:`initial-margin-agreement`.
To run the demo run:

@ -161,13 +161,13 @@ node specifies a *threshold* of how many child signatures it requires.
An illustration of an *"either Alice and Bob, or Charlie"* composite key:
.. image:: resources/composite-key.png
:width: 300px
:width: 300px
To allow further flexibility, each child node can have an associated custom *weight* (the default is 1). The *threshold*
then specifies the minimum total weight of all children required. Our previous example can also be expressed as:
.. image:: resources/composite-key-2.png
:width: 300px
:width: 300px
Verification
^^^^^^^^^^^^

@ -1,5 +1,4 @@
.. highlight:: kotlin
.. raw:: html
Using attachments
=================