Commit Graph

154 Commits

Author SHA1 Message Date
josecoll
9ec82b4bca Minor tweaks and improvements in docs TOC to aid navigation and access. 2019-03-27 15:26:17 +01:00
Mike Hearn
4dee36adc7 Docs: introduce a page about upgrading the node. 2019-02-21 12:05:07 +01:00
carolynequinn
d86ef26e68 Update index.rst
Updating the casing from uat.md to UAT.md, as it wasn't linking with the lower case (thanks to @farm !)
2019-02-20 18:49:41 +01:00
Shams Asari
a0705c2940 Deleted corda-repo-layout.rst as it's outdated and pointless to have (#4768) 2019-02-17 09:48:18 +00:00
carolynequinn
1c80fde518 Update index.rst
Adding a UAT page for the left-hand pane menu, under Corda Network title banner. (Content has already been created.)
2019-02-14 09:55:54 +01:00
Mike Hearn
dd2f1f9798 Mention Docker images in the release notes. 2019-01-16 13:33:25 +01:00
Wawrzyniec 'Wawrzek' Niewodniczanski
e003eedd38
Merge branch 'master' into wn-redo-node-conf-docs 2019-01-15 10:05:00 +00:00
Joel Dudley
5a72525d7d
Moves Contrib and Network sections up in index. Makes requesting a contribution more prominent. (#4573)
* Moves Contrib and Network sections up in index. Makes requesting a contribution more prominent.

* Review feedback.
2019-01-14 15:58:00 +00:00
Wawrzyniec 'Wawrzek' Niewodniczanski
2f18ce9440
Merge branch 'master' into wn-redo-node-conf-docs 2019-01-14 15:31:32 +00:00
Wawrzyniec Niewodniczański
6fc80604bf Move docker in menu 2019-01-08 15:52:24 +00:00
jamescarlyle
385755fb1a Updated introduction to Corda Network, with some content removed now it's
available on https://corda.network.

Signed-off-by: jamescarlyle <jwgcarlyle@gmail.com>
2018-12-27 11:31:55 +00:00
Mike Hearn
323effa236 Docs: release notes and improvements to upgrade notes for Corda 4.
Move release/app upgrade notes to the top of the toctree.

Authors: Kat Baker, Jose Coll, Mike Hearn, Tommy Lillehagen.
2018-12-21 12:56:21 +01:00
Thomas Schroeter
17e7a3ad7c
Remove documentation of building container images with jib (#4430)
This is not inline with the official container image.
2018-12-18 12:27:33 +00:00
Mike Hearn
d5169304cd Docs: add min/target version design doc to the toctree. Refresh versioning doc page. 2018-12-18 12:48:51 +01:00
James Carlyle
3a20e3f208 Updated with governance-guidelines and minor edits to other governance documents. 2018-10-30 19:27:40 +00:00
jamescarlyle
8b5faa107e Initial commit 2018-10-18 18:19:14 +01:00
Mike Hearn
1f835a3496 Add package namespace ownership design doc to toc tree 2018-10-15 17:35:56 +01:00
Joel Dudley
febe737a7a
Updates homepage link. (#4027) 2018-10-04 10:45:55 +01:00
Roger Willis
6f05f639fb
Added more docs for reference states to key concepts and api docs. (#4013)
* Added more docs for reference states to key concepts and api docs.

* Updated with requested changes
2018-10-02 16:29:19 +01:00
James Brown
7159dfcb61
CORDA-1787 Bring threat model into the docsite (#3817)
* CORDA-1787 bring threat model into docs site

* CORDA-1787 updating with full text

* CORDA-1787 update/fix typos

* CORDA-1787 update threat model with PR feedback

* CORDA-1787 fix typos

* CORDA-1787 move threat model into design section

* CORDA-1787 update formatting using pure markdown
2018-09-21 18:48:47 +01:00
Anthony Keenan
99dd2c5936
CORDA-1764: Make blobinspector use picocli base class (#3940)
* Make blobinspector use picocli base class

* Updated Documentation

* Update and harmonise documentation

* Give the table a bit more padding to help with merge conflicts

* Correct capitalisation of short options

* Some grammar changes
2018-09-14 16:37:58 +01:00
Mike Hearn
e8a1564429 Add a design doc for signature constraints. 2018-08-17 16:09:46 +02:00
Joel Dudley
753d67a519
Reword index page (#3782) 2018-08-14 10:06:30 +01:00
Anthony Keenan
b9efbaa228
CORDA-1585 - Tidy up participate docs + pdf toctree backport (#3674)
* Fix TOC for HTML and PDF (Backport from Enterprise docs)

* Tidy up participate section

* Address review comments
2018-07-24 10:05:57 +01:00
Anthony Keenan
a4ad4c7563
CORDA-1725 Add documentation on building Corda for Win/*nix and clean up doc bui… (#3578)
* Add documentation on building Corda for Win/*nix and clean up doc building documentation

* Split up building corda instructions from building docs instructions

* Address review comments
2018-07-13 22:12:20 +01:00
Thomas Schroeter
12174fdaae
Add jib gradle plugin to node (#3571)
* Add jib gradle plugin to node

Available tasks:
./gradlew node:jibExportDockerContext
./gradlew node:jib --image <image>
2018-07-12 14:39:17 +01:00
Anthony Keenan
df198acf59
Fixing md formatting sphinixification issues (#3510) 2018-07-05 09:40:36 +01:00
Anthony Keenan
3125ec9f73 [ENT-1955] Documentation fixes (#3417) 2018-06-21 16:57:30 +01:00
Michele Sollecito
e2701e69d6
[CORDA-1612]: Fix truncated code snippets in docs PDF (#3347) 2018-06-13 09:43:16 +01:00
Andras Slemmer
1eb3c25967
Merge pull request #3156 from corda/ENT-1761/aslemmer-sgx-infrastructure-design
ENT-1761: Add design doc for SGX integration into the node
2018-06-11 21:21:21 +01:00
Mike Hearn
6cc08776b5
Docs: move json to the development section (#3343) 2018-06-11 17:13:45 +02:00
Andras Slemmer
6661ee8a3e Add doc 2018-06-07 17:08:20 +01:00
Chris Rankin
21280c029e
ENT-1463, ENT-1903: Document the "determinisation" process. (#3297) 2018-06-07 16:49:39 +01:00
Thomas Schroeter
2907250468
Mark HA notary design as deprecated (#3171)
This design is superseded by the CFT notary design.

* Mark HA notary design as deprecated
* Remove outdated HA notary service design
2018-05-21 09:57:29 +01:00
Mike Hearn
75b621bdce Docs: improve appearance of notary service HA doc. 2018-05-15 16:59:35 +02:00
Mike Hearn
987875d600 Docs: improve the appearance of monitoring and management 2018-05-15 16:59:35 +02:00
Mike Hearn
9868a18361 Docs: improve appearance of the Kafka design doc. 2018-05-15 16:59:35 +02:00
Mike Hearn
f29bbb6b16 Docs: Docs: switch from ReCommonMark to m2r, as RCM is not really maintained and is buggy.
Tidy up presentation of HA design doc.

Misc markup fixes throughout, as revealed by m2r.
2018-05-15 16:59:35 +02:00
Mike Hearn
3f44910a2b Docs: use toctree to link design decisions into site. Update float design doc to fit with docsite. 2018-05-15 16:59:35 +02:00
Mike Hearn
7b6284c504 Docs: add design doc "failure detection and master election" 2018-05-15 16:59:35 +02:00
Mike Hearn
534863fb7c Minor: rename directory for cert hierarchies doc to remove JIRA ref. 2018-05-15 16:59:35 +02:00
Mike Hearn
3baf27bbc7 Docs: bring certificate hierarchy design doc across into the open repo. 2018-05-15 16:59:35 +02:00
Mike Hearn
8cac69d252 Docs: re-organise the toctree a bit more and introduce a design section
It includes (for now) just the design template.
2018-05-15 16:59:35 +02:00
Mike Hearn
2c16de8ec4 Docs: reorganise the left hand table of contents.
It now has an app dev section, an operations section, and a "participate" section.
2018-05-15 16:59:35 +02:00
Mike Hearn
2e1f591e7f Generate a PDF version of the docsite. Request from a user in Slack. 2018-03-29 10:48:58 +02:00
Joel Dudley
d60e0098f2
Removes the glossary and FAQ. Points people to StackOverflow for troubleshooting. 2018-03-16 13:41:38 +00:00
Joel Dudley
85071f227a
Reflects tutorial changes and CorDapp build docs changes from release-V1. 2017-11-16 15:31:52 +00:00
Joel Dudley
0d4c2d3526
Replaces links to Discourse with Stack Overflow links. 2017-10-30 10:09:08 +00:00
josecoll
dd3d8ba626 Merge release-v1 onto master (mostly documentation changes) (#1797)
* Updated corda release version to 1.0.0.RC2 (#1641)

* Fixed Simm Valuation Demo Test and enable serializabe java 8 lambdas. (#1655)

* [CORDA-624] Node Explorer on Issuing cash throws MissingContractAttachements exception (#1656)

(cherry picked from commit 27fea4d)

* BIGINT fix for H2 coin selection. (#1658)

* BIGINT fix for H2 coin selection.

* Review feedback

* CORDA-637 Node Explorer shows Network Map Service in Cash Issue dropdown (#1665)

* [CORDA-637] Node Explorer shows Network Map Service in Cash Issue dropdown

* add TODO to remove the hack

* Declare this internal message string as "const". (#1676)

* Merge "A variety of small fixes" into the 1.0 release branch (#1673)

* Minor: improve javadocs in NodeInfo

* Minor: use package descriptions in Kotlin build of api docs too, not just javadocs.

* RPC: make RPCConnection non-internal, as it's a core API. Move docs around so they're on public API not internal API.

* Add an IntelliJ scope that covers the currently supported Corda API.

This is useful when used in combination with the "Highlight public
declarations with missing KDoc" inspection.

* Ironic: upgrade the version of the Gradle plugin that checks for upgraded versions of things.

It had broken due being incompatible with the new versions of Gradle
itself.

* Docs: flesh out javadocs on ServiceHub

* Docs: add @suppress to a few things that were polluting the Dokka docs.

* Docs: mention RPC access in NodeInfo javadoc

* IRS Fixes to bring UI closer to declared financial types (#1662)

* Made problematic CordaRPCClient c'tor private (with internal bridge methods) and added correct c'tors for public use. (#1653)

initialiseSerialization param has also been removed.

* Fixing flow snapshot feature (#1685)

* Fix validating notary flow to handle notary change transactions properly. (#1687)

Add a notary change test for checking longer chains involving both regular and notary change transactions.

* Unification of VaultQuery And VaultService APIs (into single VaultService interface) to simplify node bootstrapping and usability. (#1677) (#1688)

* Identity documentation (#1620)

* Sketch initial identity docs

* Restructure confidential identity docs to better fit structure

* Split confidential identities into API and concepts

* Further expansion on basic identity conceptS

* Merge Party type into api-identity.rst

* Address feedback on written content

* Rework inline code with literalinclude

* Start addressing feedback from Richard

* Clarify use of "counterparty"

* Address comments on key concepts

* Correct back to US english

* Clarify distribution/publishing of identities

* Update changelog around confidential identities

* CORDA-642 Notary demo documentation fixes (#1682)

* Notary demo documentation fixes.

* One of the tables is prefixed.

* CORDA-641: A temporary fix for contract upgrade transactions (#1700)

* A temporary fix for contract upgrade transactions:
during LedgerTransaction verification run the right logic based on whether
it contains the UpgradeCommand.

* Move ContractUpgradeFlowTest away from createSomeNodes()

* Remove assembleBareTx as it's not used

* Update corda version tag to 1.0.0-RC3 (#1705)

* Hide SerializationContext from public API on TransactionBuilder (#1707)

* Hide SerializationContext from public API on TransactionBuilder

(cherry picked from commit 6ff7b7e)

* Hide SerializationContext from public API on TransactionBuilder

(cherry picked from commit 6ff7b7e)

* Address feedback on confidential identities docs (#1701)

* Address minor comments on confidential identities docs

* Expand on implementation details of confidential identities

* Cleanup

* Clarify details of the data blob in the swap identites flow

* Add that certificate path is not made public for confidential identities

* FlowSession docs (#1693)

* FlowSession docs (#1660)

* FlowSession docs

* PR comments

* Milder example flow name

* Fixes bugs with contract constraints (#1696)

* Added schedulable flows to cordapp scanning

Fixed a bug where the core flows are included in every cordapp. Added a test to prove the scheduled flows are loaded correctly. Added scheduled flow support to cordapp.

Renabled broken test.

Fixed test to prove cordapps aren't retreived from network.

Review fixes.

Fixed a test issue caused by gradle having slightly different paths to IntelliJ

* Fixed test for real this time.

* Consistent use of CordaException and CordaRuntimeException (#1710)

* Custom exceptions in corda, should either derive from an appropriate closely related java exception, or CordaException, or CordaRuntimeException. They should not inherit just from Exception, or RuntimeException.

Handle PR comments

Add nicer constructors to CordaException and CordaRuntimeException

* Fix ambiguous defaulted constructor

* Add @suppress (#1725)

* Git-ignore Node Explorer config. (#1709)

* add message warning windows users they might need to manually kill explorer demo nodes started by gradle (#1717) (#1726)

* Misc documentation fixes (#1694)

(cherry picked from commit 592896f)

* Document -parameters compiler arg for Java CorDapps. (#1712)

* Correct non-anonymous two party trade flow (#1731)

* Parameterize TwoPartyTradeFlowTests to confirm deanonymised functionality works.
* Correct handling of counterparty using well known identity in TWoPartyTradeFlow

* CORDA-594 - SIMM Demo doc update (#1723) (#1735)

* CORDA-594 - SIMM Demo doc update

For V1 write a series of JSON / curl commands a user can follow to run
the demo

* Review Comments

* Updated the rationale behind as to why SIMM was introduced.

* typo

* Cordapps now have a name field. (#1664)

Corrected cordapp name generation.

Added changelog entry.

* Small API fixes against M16 (#1737)

* Move CompositeSignaturesWithKeys into net.corda.core.crypto package.

(cherry picked from commit 8f29562)

* Rename and move CordaPluginRegistry to reflect its real purpose now.
Simplify serialization code a bit.

(cherry picked from commit e2ecd3a)

* Docs: docsite improvements

* Remove discussion of webserver from 'writing a cordapp' page.
* Fixup some flow docs.
* Add a couple more package descriptions.

(cherry picked from commit 2aedc43)

* Review comments

(cherry picked from commit ba1d007)

* Review comments - always apply default whitelist and no longer load it via ServiceLoader

(cherry picked from commit 7d4d7bb)

* Added wording about renaming services resource file

* Update corda version tag to 1.0.0-RC4 (#1734)

* Update corda version tag to 1.0.0-RC3

* Update corda version tag to 1.0.0-RC4

* Update build.gradle

* V1 tests and fixes for the ContractConstraints work (#1739)

* V1 tests and fixes for the ContractConstraints work

* More fixes.

* Added a contract constraints section to the key concepts doc. (#1704)

Documentation for contract constraints.

Added to index.

Review fixes round 1.

More review fixes.

Review fixes.

Explained package contents.

review fixes.

Addressed RGB's final review comments.

Updated source code type to 'java'

* Fixes dead links. (#1749)

* Update gradle plugins version to 1.0.0 (#1753)

* Update Readme (#1756)

* Update Readme

Minor tweaks to Readme -- consistent capitalisation and more descriptive list of features (also reordered to put the important things first)

* Copied master readme.

* Update Readme

Minor tweaks to Readme -- consistent capitalisation and more descriptive list of features (also reordered to put the important things first)

* Fixes .rst formatting. (#1751)

* Updates tutorials. (#1649)

* Updates tutorials.

* Addresses review comments.

* Tutorial refresh for v1.0 and moving of code into separate files. (#1758)

* Moves code sections in tutorials to code files.

* Removes wallet references.

* Updates repo layout doc.

* Removes remaining cordapp-tutorial references, replaced with cordapp-example.

* Fixes broken link.

* Misc docs fixes.

* Refreshes the ServiceHub and rpc ops api pages.

* Updates the cheat sheet.

* Updates cookbooks.

* Refreshes the running-a-notary tutorial.

* Updates flow-testing tutorial

* Updates tear-offs tutorial.

* Refreshes integration-testing tutorial.

* Updates to contract tutorial and accompanying code to bring inline with V1 release.

* Refreshes contract-upgrade tutorial.

* Fixed broken code sample in "writing a contract" and updated contracts dsl.

* Added contract ref to java code. Fixed broken rst markup.

* Updates transaction-building tutorial.

* Updates the client-rpc and flow-state-machines tutorials.

* Updates the oracles tutorial.

* Amended country in X500 names from "UK" to "GB"

* Update FlowCookbook.kt

* Amended cheatsheet. Minor update on contract upgrades tutoraial.

* Added `extraCordappPackagesToScan` to node driver.

* Changes to match new function signature.

* Update to reflect change in location of cash contract name.

* CORDA-670: Correct scanned packages in network visualiser (#1763)

* Add CorDapp dependency of IRS to network visualiser

* Set CorDapp directories

* Checking out the latest milestone will no longer be required. (#1761)

* Updated documentation indices (#1754)

* Update documentation indices.

* Reference a moveable tag for V1 docs.
Remove redundant warning text.

* Reverted proposed usage of new docs release tag

* Minor: print a deprecation warning when the web server starts. (#1767)

* Release and upgrade notes for V1.0 (#1736)

* Release and upgrade notes for V1.0

* Update changelog.rst

* Update changelog.rst

* Formatting.

* Incorporating review feedback from KB and MN.

* "guarantee" instead of "promise"

* Updated with final review comments from KB and RGB.

* Updated upgrade notes to describe migration from removed CordaPluginRegistry.

* Minor clarification.

* Minor updates following final RGB feedback.

* Kat's further pedantic feedback

* Minor changes following feedback from KB.

* Incorporating review feedback from MH.

* killed 'patent-pending'

* Made the visualiser into a regular JVM module - not a CorDapp. (#1771)

* Docs: more package descriptions and take non-stabilised APIs out of the docs build. (#1775)

* Update corda version tag to 1.0.0

* Updated release notes to fix minor typos (#1779)

Fixed bold type on simplified annotation driven scanning bullet and added bold type to module name bullets

* Fixed drop down.. probably. (#1780)

* fixed formatting for release notes. (#1782)

* Improve API page wording (#1784)

* Removed "unreleased" sections from the release notes and change log.

* Merge remote-tracking branch 'origin/release-V1' into colljos-merge-v1-docs

# Conflicts:
#	build.gradle
#	client/jfx/src/main/kotlin/net/corda/client/jfx/model/NodeMonitorModel.kt
#	client/rpc/src/main/kotlin/net/corda/client/rpc/CordaRPCClient.kt
#	client/rpc/src/main/kotlin/net/corda/client/rpc/PermissionException.kt
#	constants.properties
#	core/src/main/kotlin/net/corda/core/flows/FlowSession.kt
#	core/src/test/kotlin/net/corda/core/contracts/DummyContractV2Tests.kt
#	core/src/test/kotlin/net/corda/core/flows/ContractUpgradeFlowTest.kt
#	docs/source/api-flows.rst
#	docs/source/api-index.rst
#	docs/source/changelog.rst
#	docs/source/example-code/src/main/java/net/corda/docs/java/tutorial/testdsl/CommercialPaperTest.java
#	docs/source/example-code/src/main/kotlin/net/corda/docs/FlowCookbook.kt
#	docs/source/example-code/src/main/kotlin/net/corda/docs/tutorial/contract/TutorialContract.kt
#	docs/source/example-code/src/main/kotlin/net/corda/docs/tutorial/testdsl/TutorialTestDSL.kt
#	docs/source/hello-world-state.rst
#	docs/source/key-concepts-contract-constraints.rst
#	docs/source/serialization.rst
#	docs/source/tut-two-party-flow.rst
#	docs/source/tutorial-tear-offs.rst
#	node-api/src/main/kotlin/net/corda/nodeapi/internal/serialization/CordaClassResolver.kt
#	node-api/src/test/java/net/corda/nodeapi/internal/serialization/ForbiddenLambdaSerializationTests.java
#	node-api/src/test/java/net/corda/nodeapi/internal/serialization/LambdaCheckpointSerializationTest.java
#	node/src/integration-test/kotlin/net/corda/node/services/AttachmentLoadingTests.kt
#	node/src/integration-test/kotlin/net/corda/services/messaging/MQSecurityTest.kt
#	node/src/main/kotlin/net/corda/node/internal/NodeStartup.kt
#	node/src/test/kotlin/net/corda/node/internal/cordapp/CordappLoaderTest.kt
#	node/src/test/kotlin/net/corda/node/services/NotaryChangeTests.kt
#	samples/attachment-demo/src/main/kotlin/net/corda/attachmentdemo/AttachmentDemo.kt
#	samples/trader-demo/src/main/kotlin/net/corda/traderdemo/TraderDemo.kt
#	testing/node-driver/src/integration-test/kotlin/net/corda/testing/FlowStackSnapshotTest.kt
#	testing/node-driver/src/main/kotlin/net/corda/testing/driver/Driver.kt
#	testing/node-driver/src/main/kotlin/net/corda/testing/node/MockNode.kt
#	webserver/src/main/kotlin/net/corda/webserver/internal/NodeWebServer.kt
2017-10-03 17:32:11 +01:00
Joel Dudley
7fdbf1fa4a Adds a link to Hello, Word. Other minor fixes. 2017-06-20 11:26:36 +01:00