Commit Graph

149 Commits

Author SHA1 Message Date
Chris Rankin
b7fe8d6b3c Update documentation for M11.1. (#685) 2017-05-15 17:23:07 +01:00
Roger Willis
6d1462f8eb CollectSignaturesFlow (#560)
* Initial commit for CollectSignaturesFlow, some tests and associated documentation via a new "Flow Library" section of the docsite.

* Refactored the TwoPartyDealFlow to use the CollectSignaturesFlow.

* Added the subclassed CollectsigsFlow to the trader demo, whitelisted it and added a flow initiator for the responder.

* Minor edits to progress tracker.

* Amended as per Rick's comments.

* Generalised this flow, so it now works if more than one signatures have been collected, initially.

* Minor edits to the IRS demo so it uses the CollectSignaturesFlow.

* For debugging purposes...

* Adding CollectsigsFlow support to SIMM Demo.

* Removing debug logging.

* Amended top level comment: transactions can only have one notary.

* Added TODOs as checkTransaction logic is absent.

* Addressed Mike's review comments.

* Minor edit to flow-library docs.

* Updated flow based on Mike's review comments.

* Added two usage examples and updated the tests.

* Made changes to accommodate new CollectSignaturesFlow approach.

* Made changes to SIMM demo to accommodate new CollectSignaturesFlow approach.

* Added abstract check proposal method to two party deal flow.

* Added missing TODOs.

* Addressed Sham's comments.

* Rebased to M11.
2017-05-11 14:37:53 -04:00
Chris Rankin
fc50860dae Fix current version. (#670) 2017-05-11 17:07:14 +01:00
Joel Dudley
ce8e40df50 Adds the cheat sheet to the docsite. (#556)
* Adds the cheat sheet to the docsite.

* Added a JPG of the cheatsheet and included it in the docsite page.
2017-05-03 12:59:40 +01:00
Shams Asari
b5e022f350 Introducing Platform Version and its use by the NMS for min version requirements for the network 2017-04-24 15:31:10 +01:00
Patrick Kuo
f4bdb00f70 Bump version to M10.1 in docs for release (#517) 2017-04-07 16:28:18 +01:00
Patrick Kuo
7b216d6dc3 M10 release note (#509) 2017-04-07 10:12:01 +01:00
Chris Rankin
0bbc330a04 CORDA-307: Initial DemoBench documentation. (#408)
* CORDA-307: Initial DemoBench documentation.
* CORDA-307: Update with review comments.
* CORDA-307: Update local installation instructions and download site.
* CORDA-307: Remove download link because it's not ready yet.
* CORDA-307: Mention that the node.conf files within the profiles can be edited by the user.
* CORDA-307: Add DemoBench section to the appendix.
2017-03-31 14:16:32 +01:00
Andras Slemmer
48952dfc02 Add node-api, split minimal node functionality, OutOfProcessTransactionVerifierService 2017-03-27 17:42:51 +01:00
Clinton Alexander
a40d55df84 Updated docs to refer to the latest M9.2 release. 2017-03-27 16:33:33 +02:00
Marek Skocovsky
262c87a5c6 Integrate CRaSH shell (SSHD). Joint effort between Mike Hearn and Marek Skocovsky.
The shell is embedded in the node and offers the ability to monitor
and control the node via the launching terminal.

Still to do:

* Switch to a fork of CRaSH that we can maintain ourselves, and merge in Marek's SSH patch so we can enable SSH access.
* Add persistent command history that survives restarts.
* Tab completion for the 'flow' and 'run' commands.
* Remove the 'jul' command and replace it with a command that lets you see and tail the log4j logs instead.
* Fix or remove the other crash commands that have bitrotted since 2015.
2017-03-24 12:44:54 +01:00
Mike Hearn
d281fe82b5 Docs: misc fixes and tweaks to the docsite. 2017-03-21 18:01:17 +01:00
Mike Hearn
ce0dcafb95 Document JSON/Jackson support 2017-03-08 12:31:22 +01:00
Ross Nicoll
db97ddb030 Update index and set up versions 2017-03-08 10:07:02 +00:00
Ross Nicoll
285479a963 Add draft release notes for M9 2017-03-02 16:41:43 +00:00
Ross Nicoll
caea578093 Add M9 draft change log 2017-03-02 16:41:43 +00:00
Mike Hearn
cc61be5b6a Inform users about the newly available Corda training programs at startup and in the docsite. 2017-02-28 16:50:43 +01:00
Rick Parker
c4c4c51d7d Kryo serialisation whitelisting and misc enhancements. (#267)
Kryo serialisation whitelisting and misc enhancements
2017-02-28 08:12:18 +00:00
Clinton Alexander
91a72bb345 Updated docs to M8.2 2017-02-22 10:52:47 +00:00
Patrick Kuo
28e83d1e66 Example code for contract upgrade using RPC. (#237)
* Added missing out modifier to UpgradedContract class
* Added ContractUpgradeFlow.Instigator to whitelist in AbstractNode
* Added test for contract upgrade using RPC
2017-02-13 15:39:48 +00:00
Patrick Kuo
c054ffe719 Add support for contract upgrades (#165)
* Add support for contract upgrades
* Add interface for the upgraded contract to implement, which provides functionality for upgrading legacy states.
* Add shared upgrade command and verification code for it.
* Add DummyContractV2 to illustrate what an upgraded contract looks like.
* Add new functions to vault service to support upgrading state objects.
* Add contract upgrade flow
2017-02-09 17:14:31 +00:00
Joel Dudley
b3e26b2022 Changes docs to point to cordapp-tutorial instead of cordapp-template as appropriate. 2017-02-08 10:34:54 +00:00
Andrius Dagys
f1025e999b Update notice on the docs index page to point to release M8
Regenerate docs
2017-02-07 17:18:21 +00:00
Joel Dudley
cfcfb30beb Provides clearer instructions on the 'Getting set up' page. Expands 'Troubleshooting' page. 2017-01-31 12:59:24 +00:00
josecoll
ac1d14464c Key Concepts rewrite for open source day (#7)
First draft

Re-structured Key Concepts; added plenty of diagrams; additional content.

Added references to other security docs.

Re-structured Key Concepts; added plenty of diagrams; additional content.

Added references to other security docs.

Updated information, indexes and images.

Incorporated feedback from PR review comments (RGB, RW)

Reformatted diagrams and incorporated feedback from PR reviewers.

Addressed formatting problems.

Updated Flow Framework diagram

Added colour coding to Flow Framework diagram to aid readibility.

Small clarification to vault unconsumed state usage.

Added tutorial reference as suggested by RGB

Updated TOC tree.

Updates following PR review comment from Roger

First pass updates following PR review comments from MH.

Further updates following PR review (including 2 edited diagrams)

Diagram changes and minor text edits following review with MGB

Remove unused diagrams.

Fixed spurious indentation errors.

Changes following review and feedback from JD.
Added clauses and merkle-trees back into TOC.
Added small sub-section on transaction representation in Data Model.
Added future work as note in Vault.

Minor updates to diagrams following MH review.

Updated Corda Ecosystem diagram.

Minor changes to Core & Financial docs following PR review by MH.

Updated following review by MBG.
2017-01-26 15:46:40 +00:00
Joel Dudley
d87c9eb9d2 Updates the docs landing page to give clear direction to new users. 2017-01-10 10:18:38 +00:00
Joel Dudley
a8a371fcda Regens docs. 2017-01-06 17:38:23 +00:00
Joel Dudley
b5c319aeca Unix vs Windows demo instructions. Duplicate SIMM page. Typos. Bad nesting. 2017-01-06 11:05:37 +00:00
David Lee
ffe1d234ca Added first draft documentation on the Azure VM (#67)
* Added first documentation on the Azure VM
2016-12-21 09:57:37 +00:00
Clinton Alexander
467e2fc4aa Added new documentation to the index. 2016-12-08 12:14:17 +00:00
Richard Green
e1e6d187e3 Making the warning make sense for branches that aren't master 2016-12-06 10:51:29 +00:00
Mike Hearn
1323781a30 Docs: point to M6 docs from master branch warning 2016-11-29 20:49:14 +00:00
RogerWillis
3ecf5b786a Minor docs tweaks:
* Removed "where-to-start" as it was old and will be replaced with the developing CorDapps page.
* Re-arranged the index page.
* Put the getting started fault finding page on the index (it wasn't referenced before).
* Deleted the "building cordapps" page as requested by Mike.
2016-11-29 18:31:28 +00:00
Richard Green
c9d6c4d8ee Adding a CLI / IDE page 2016-11-29 16:23:47 +00:00
Matthew Nesbit
4a504ca3dc Created some examples to include in tutorial on building transactions.
Complete the transaction building doc with code fragments.

Fix gradle build

Handle PR comments

Put back in missing main class line

Couple of minor improvements from PR
2016-11-29 14:50:20 +00:00
Roger Willis
b3e5bede39 Merged in rog-cordapp-tutorial (pull request #490)
First pass on Corda SDK tutorial
2016-11-29 13:47:08 +00:00
RogerWillis
9c9691ae77 Addressed review points. Added a stub file in the getting started section that indicates devs should look at the cordapp tutorial. 2016-11-29 13:45:58 +00:00
Katarzyna Streich
e10b199ae1 Add clauses documentation. 2016-11-29 11:53:54 +00:00
Andras Slemmer
ba84ce7358 Merged in aslemmer-integtest-docs (pull request #553)
docs: Add integration test tutorial
2016-11-29 11:47:27 +00:00
RogerWillis
435e7da93f Changed SDK tutorial based on latest repo changes and some feedback.
Addressed some review comments.

Latest changes to SDK tutorial based on review comments.

Corda SDK -> CorDapp Template

Addressed review comments + added some new sections.

Added pic of run config drop down menu.

Added a couple of additional sections.

Refactored the 'how to make a cordapp' how to a separate docs pages and stubbed it out for comments.

Added index.rst

Additional changes based on feedback.

Addressed review comments. Removed spurious buuildinfo file.

Minor changes based on richard's comments. Still waiting on resolution of dev experience preference.

Changed milestone release workflow. Users now should checkout a specific tag.
2016-11-28 15:42:48 +00:00
Andrius Dagys
2f37024af7 Added tutorials on how to use & run a notary. 2016-11-28 15:15:13 +00:00
RogerWillis
d243ef298a Beginnings of CorDapp SDK tutorial 2016-11-28 14:19:43 +00:00
Shams Asari
2f769b3db0 Cleaning up doc headers to be consistent wrt casing 2016-11-28 14:08:16 +00:00
Andras Slemmer
c6a994aca2 docs: Add setting-up-a-corda-network to index.html 2016-11-28 11:58:14 +00:00
Andras Slemmer
220ccdbe13 docs: Add integration test tutorial 2016-11-28 11:52:12 +00:00
Patrick Kuo
be81e9b620 permissioning doc 2016-11-25 16:33:00 +00:00
rick.parker
492005bcfe Fix up and improve some docs 2016-11-24 15:06:10 +00:00
rick.parker
d68cc0467c Fix bad merge on index.rst 2016-11-24 08:21:21 +00:00
Matthew Nesbit
6ecdf5a946 Document on plugin loading framework and a tiny tweak on logging.
Word wrap document.

Change protocol to flow.

Try to improve plugin discussion based on PR comments.

add comma
2016-11-23 17:20:56 +00:00
Matthew Nesbit
345d62542d Rather brief description of every service implemented in the node project.
Take on fixes from PR.

Change protocol to flow.

Update for Shams's comments

Fix typos
2016-11-23 09:17:30 +00:00
rick.parker
6c3476e89f Rename protocol to flow in docs 2016-11-23 08:29:14 +00:00
Richard Green
4f6ad344fe Adding glossary 2016-11-22 11:35:57 +00:00
Richard Green
2ec18d322f Changes from a doc review that were omitted in first PR, also changes from corda=samples repo 2016-11-18 17:58:52 +00:00
Rick Parker
f90c5a702a Merged in parkri-new-docs-layout (pull request #494)
Doc index structure change
2016-11-18 14:13:52 +00:00
rick.parker
864a48b800 Doc index structure change 2016-11-18 12:17:32 +00:00
Mike Hearn
0ed3855051 Docs: add load testing page to the appendix 2016-11-18 13:16:06 +01:00
Mike Hearn
9d7bfe4229 Publish technical white paper to the docsite 2016-11-16 14:57:14 +01:00
Katarzyna Streich
21b4ab0c26 Add transaction tear-offs documentation. 2016-11-08 17:45:28 +00:00
Mike Hearn
3ae25dbff5 Release notes for M5
Add a snapshot of the tech whitepaper.

Misc doc fixes. Change README to prepare for the open source release.
2016-11-07 17:57:01 +01:00
Patrick Kuo
6525de7e17 Explorer Doc 2016-11-04 13:41:21 +00:00
Mike Hearn
b7afd54d29 Minor: docs, fix header level in cordapp page. 2016-10-12 12:54:23 +02:00
Ross Nicoll
f1557e687b Add attachement demo and documentation
Add a demo of attachments on transactions as a worked example for others to use, along with documentation
on how to run it, and how it functions.
2016-10-05 14:29:20 +01:00
rick.parker
ec975b0426 Hibernate ORM implementation for states. 2016-10-05 11:40:27 +01:00
Andras Slemmer
3b77de67b6 docs: add docs/source/example-code module, tutorial on the Client RPC API 2016-10-05 10:40:18 +01:00
Ross Nicoll
119f923932 Add documentation for network simulator 2016-09-19 11:57:14 +01:00
Ross Nicoll
47e404f8b0 Remove docs on network visualiser 2016-09-19 11:53:41 +01:00
Mike Hearn
4d83f1489f Add a client library that provides an RPC mechanism for talking to the Corda node.
The RPC mechanism uses message queues and is essentially conventional except for the fact that it supports marshalling observables. An observable encapsulates a stream of ongoing events, and server-side observables sent to the client are automatically bound to message queues and managed by Artemis.
2016-09-16 10:13:21 +01:00
Mike Hearn
423aff477a Add a short document that describes things to watch out for when writing Corda app code. 2016-09-07 13:09:39 +02:00
Matthew Nesbit
638dfc902a docs
Include database config section for completeness

Incorporate comments from review

Incorporate comments from review
2016-08-31 11:47:25 +01:00
Mike Hearn
cc2209f7b1 Docsite: add a warning to the index page about the docsite being for master, and update the release process doc to remind the release master to remove it on the branch. 2016-08-30 12:53:34 +02:00
Clinton Alexander
c03d9a2cf7 Review fixes. 2016-08-24 15:33:43 +01:00
richard
9e9f75b932 Added Corda Whitepaper 2016-08-11 13:57:41 +01:00
Mike Hearn
a5c8df8dab # This is a combination of 2 commits.
# The first commit's message is:

Release notes for M2

# The 2nd commit message will be skipped:

#	Docs: Address release notes review comments, re-arrange the sidebar and mention the new TF code that has been added.
2016-08-01 13:12:39 +02:00
Ross Nicoll
98aac62a42 Add contract catalogue to documentation 2016-07-29 11:59:28 +01:00
Ross Nicoll
1943b3633f Add documentation on contract clauses 2016-07-12 17:47:51 +01:00
Andras Slemmer
dae39bbfc1 docs: Add tutorial on the test DSL 2016-07-11 14:25:27 +01:00
rick.parker
5271882dcd Event scheduling and docs for event scheduling 2016-06-30 08:51:52 +01:00
Ross Nicoll
9cdcaaa606 Add documentation of transaction data types 2016-06-13 17:38:18 +01:00
Mike Hearn
68824e9d7e Docsite: added a release notes page 2016-05-24 13:27:16 +02:00
Mike Hearn
6f1e2047dd Docs: add a doc that describes how to link the other tutorials together into a demo. 2016-05-18 19:05:33 +02:00
Mike Hearn
06cf7a21be Docs: misc markup fixes and adjust an out of date paragraph about oracles. 2016-05-17 19:40:53 +02:00
Mike Hearn
e38b101970 Merged in release-process-docs (pull request #88)
Add a page that briefly describes the proposed release process.
2016-05-16 15:55:31 +02:00
Andrius Dagys
e77d3a40bd Added docs for the Notary 2016-05-13 16:17:50 +01:00
Mike Hearn
61605b18e3 Add a page that briefly describes the proposed release process. 2016-05-10 18:44:41 +02:00
Ross Nicoll
20c6be193a Move tutorial.rst to tutorial_contract.rst
Move tutorial.rst to tutorial_contract.rst and rebuild docs
2016-05-09 10:20:40 +01:00
Ross Nicoll
c13b5f247e Add tutorial on building documentation 2016-04-28 17:44:33 +01:00
Mike Hearn
45e89fe4ad Docsite: add info on how to run the IRS demo and rename the demos section 2016-04-18 19:44:21 +02:00
Mike Hearn
d08f7905df Regen docsite and link IRS page into it (was previously invisible) 2016-04-18 19:25:41 +02:00
Mike Hearn
07f925a9f7 Docs: remove roadmap, add a new doc page on oracles. 2016-03-11 13:42:11 +01:00
Mike Hearn
3db5b234d1 Docs: add link from docsite to api docs 2016-03-08 18:32:13 +01:00
Mike Hearn
4fd4a348cb Add a section to the docsite about node administration, cover attachment upload/download. 2016-03-04 16:15:32 +01:00
Mike Hearn
c2a10e8fae Add a page to the docsite about the trading demo. 2016-02-03 16:57:01 +01:00
Mike Hearn
c16abb2825 Add a coding style guide. 2016-01-27 15:07:46 +00:00
Mike Hearn
89b1a5648b Docs: regen HTML + reorganise left hand menu a bit. 2015-12-22 15:15:38 +00:00
Mike Hearn
4198de7ff0 Messaging: add docs on the messaging and protocol state machine systems. 2015-12-14 18:22:21 +01:00
Mike Hearn
e5a36580da Visualiser: reorganise, make it easier to invoke, document it. 2015-12-03 12:00:49 +00:00
Mike Hearn
2f7da660c2 Fill out roadmap doc page and state the core hypothesis that the prototype is exploring on the welcome page. 2015-12-01 14:05:08 +00:00
Mike Hearn
8ea4ac8b15 Rename 'playground' to 'R3 Prototyping' 2015-11-30 17:00:25 +00:00
Mike Hearn
3dd10714df Introduce documentation of the current prototype with a contract programming tutorial (incomplete), using the Sphinx docs engine.
Actual generated HTML will follow in the next commit.
2015-11-25 18:01:37 +01:00