ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-25 15:41:10 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
d5872f4e5b
corda/docs/source/index.rst

137 lines
4.2 KiB
ReStructuredText
Raw Normal View History

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-17 18:31:17 +00:00
Welcome to the Corda documentation!
===================================
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 13:27:07 +00:00
Making the warning make sense for branches that aren't master
2016-12-06 10:12:57 +00:00
.. warning:: This build of the docs is from the "|version|" branch, not a milestone release. It may not reflect the
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
current state of the code. `Read the docs for milestone release M8 <https://docs.corda.net/releases/release-M8.0/>`_.
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 10:53:34 +00:00
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
`Corda <https://www.corda.net/>`_ is an open-source distributed ledger platform. The latest *milestone* (i.e. stable)
release is M8. The codebase is on `GitHub <https://github.com/corda>`_, and our community can be found on
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
`Slack <https://slack.corda.net/>`_ and in our `forum <https://discourse.corda.net/>`_.
Added Corda Whitepaper
2016-08-11 12:57:41 +00:00
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
If you're new to Corda, you should start by learning about its motivating vision and architecture. A good introduction
is the `Introduction to Corda webinar <https://vimeo.com/192757743/c2ec39c1e1>`_ and the `Introductory white paper`_. As
they become more familiar with Corda, readers with a technical background will also want to dive into the `Technical white paper`_,
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
which describes the platform's envisioned end-state.
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
Corda is designed so that developers can easily extend its functionality by writing CorDapps
(**Cor**\ da **D**\ istributed **App**\ lication\ **s**\ ). Some example CorDapps are available in the Corda repo's
`samples <https://github.com/corda/corda/tree/master/samples>`_ directory. To run these yourself, make
sure you follow the instructions in :doc:`getting-set-up`, then go to
Provides clearer instructions on the 'Getting set up' page. Expands 'Troubleshooting' page.
2017-01-31 12:59:24 +00:00
:doc:`running-the-demos`.
Changes docs to point to cordapp-tutorial instead of cordapp-template as appropriate.
2017-02-08 10:34:54 +00:00
If, after running the demos, you're interested in writing your own CorDapps, you can use the
`CorDapp template <https://github.com/corda/cordapp-template>`_ as a base. A simple example CorDapp built upon the template is available `here <https://github.com/corda/cordapp-tutorial>`_, and a video primer on basic CorDapp structure is available `here <https://vimeo.com/192797322/aab499b152>`_.
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
From there, you'll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts,
and/or flows). For this, you'll want to refer to this docsite, and to the `tutorials <https://docs.corda.net/tutorial-contract.html>`_
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
in particular. If you get stuck, get in touch on `Slack <https://slack.corda.net/>`_ or the `forum <https://discourse.corda.net/>`_.
Update notice on the docs index page to point to release M8 Regenerate docs
2017-02-06 16:52:15 +00:00
Once you're familiar with Corda and CorDapp development, we'd encourage you to get involved in the development of the
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
platform itself. Find out more about `contributing to Corda <https://github.com/corda/corda/wiki/Corda's-Open-Source-Approach>`_.
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 13:27:07 +00:00
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-04 13:10:27 +00:00
.. _`Introductory white paper`: _static/corda-introductory-whitepaper.pdf
.. _`Technical white paper`: _static/corda-technical-whitepaper.pdf
Docs: add link from docsite to api docs
2016-03-08 17:32:13 +00:00
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
Documentation Contents:
=======================
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 13:27:07 +00:00
.. toctree::
:maxdepth: 2
Doc index structure change
2016-11-18 12:17:32 +00:00
:caption: Getting started
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 13:27:07 +00:00
inthebox
getting-set-up
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
getting-set-up-fault-finding
Doc index structure change
2016-11-18 12:17:32 +00:00
running-the-demos
Adding a CLI / IDE page
2016-11-28 11:44:03 +00:00
CLI-vs-IDE
Doc index structure change
2016-11-18 12:17:32 +00:00
.. toctree::
:maxdepth: 2
:caption: Key concepts
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
key-concepts
key-concepts-ecosystem
key-concepts-data-model
key-concepts-core-types
key-concepts-financial-model
key-concepts-flow-framework
key-concepts-consensus-notaries
key-concepts-vault
key-concepts-security-model
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
.. toctree::
:maxdepth: 2
:caption: CorDapps
creating-a-cordapp
tutorial-cordapp
Doc index structure change
2016-11-18 12:17:32 +00:00
.. toctree::
:maxdepth: 2
:caption: The Corda node
clientrpc
Messaging: add docs on the messaging and protocol state machine systems.
2015-12-14 17:22:21 +00:00
messaging
Hibernate ORM implementation for states.
2016-09-27 14:17:27 +00:00
persistence
Add a section to the docsite about node administration, cover attachment upload/download.
2016-03-04 15:15:32 +00:00
node-administration
Cleaning up doc headers to be consistent wrt casing
2016-11-25 14:29:13 +00:00
corda-configuration-file
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-22 11:57:11 +00:00
corda-plugins
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-21 18:14:18 +00:00
node-services
permissioning doc
2016-11-24 16:38:40 +00:00
node-explorer
permissioning
# 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-07-28 10:46:12 +00:00
Docs: regen HTML + reorganise left hand menu a bit.
2015-12-22 15:15:38 +00:00
.. toctree::
:maxdepth: 2
:caption: Tutorials
Docs: misc markup fixes and adjust an out of date paragraph about oracles.
2016-05-17 17:40:53 +00:00
tutorial-contract
Add documentation on contract clauses
2016-07-12 09:24:11 +00:00
tutorial-contract-clauses
docs: Add tutorial on the test DSL
2016-07-08 17:33:48 +00:00
tutorial-test-dsl
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
contract-upgrade
docs: Add integration test tutorial
2016-11-25 15:26:00 +00:00
tutorial-integration-testing
docs: add docs/source/example-code module, tutorial on the Client RPC API
2016-10-04 12:56:31 +00:00
tutorial-clientrpc-api
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-28 13:39:34 +00:00
tutorial-building-transactions
Fix bad merge on index.rst
2016-11-24 08:21:21 +00:00
flow-state-machines
Fix up and improve some docs
2016-11-21 17:11:51 +00:00
flow-testing
Added tutorials on how to use & run a notary.
2016-11-25 15:11:19 +00:00
running-a-notary
using-a-notary
Docs: remove roadmap, add a new doc page on oracles.
2016-03-11 12:42:11 +00:00
oracles
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-09-23 13:41:29 +00:00
tutorial-attachments
Event scheduling and docs for event scheduling
2016-05-24 09:03:29 +00:00
event-scheduling
Docs: regen HTML + reorganise left hand menu a bit.
2015-12-22 15:15:38 +00:00
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-08-26 13:31:17 +00:00
.. toctree::
:maxdepth: 2
Doc index structure change
2016-11-18 12:17:32 +00:00
:caption: Other
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-08-26 13:31:17 +00:00
Doc index structure change
2016-11-18 12:17:32 +00:00
network-simulator
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
clauses
merkle-trees
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-08-26 13:31:17 +00:00
.. toctree::
:maxdepth: 2
Doc index structure change
2016-11-18 12:17:32 +00:00
:caption: Component library
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-08-26 13:31:17 +00:00
Doc index structure change
2016-11-18 12:17:32 +00:00
contract-catalogue
contract-irs
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-08-26 13:31:17 +00:00
Docs: regen HTML + reorganise left hand menu a bit.
2015-12-22 15:15:38 +00:00
.. toctree::
:maxdepth: 2
:caption: Appendix
Docs: add load testing page to the appendix
2016-11-18 12:16:06 +00:00
loadtesting
docs: Add setting-up-a-corda-network to index.html
2016-11-28 11:58:14 +00:00
setting-up-a-corda-network
Minor: docs, fix header level in cordapp page.
2016-10-12 10:54:23 +00:00
secure-coding-guidelines
Add a page that briefly describes the proposed release process.
2016-05-10 16:44:41 +00:00
release-process
Docsite: added a release notes page
2016-05-24 11:26:17 +00:00
release-notes
Add a coding style guide.
2016-01-27 15:01:33 +00:00
codestyle
Add tutorial on building documentation
2016-04-27 17:37:27 +00:00
building-the-docs
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
further-notes-on-kotlin
Added new documentation to the index.
2016-12-08 12:14:17 +00:00
publishing-corda
Added first draft documentation on the Azure VM (#67) * Added first documentation on the Azure VM
2016-12-21 09:57:37 +00:00
azure-vm
Doc index structure change
2016-11-18 12:17:32 +00:00
.. toctree::
:maxdepth: 2
:caption: Glossary
Adding glossary
2016-11-21 16:00:22 +00:00
glossary
Reference in New Issue Copy Permalink