From bf237ca7e2d1a7971b57eeb38f1e77dd1df22bea Mon Sep 17 00:00:00 2001 From: Katelyn Baker Date: Sun, 27 Jan 2019 13:29:44 +0000 Subject: [PATCH 1/2] CORDA-2509 - Updating release notes --- docs/make-docsite.sh | 2 +- docs/source/release-notes.rst | 27 +++++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/make-docsite.sh b/docs/make-docsite.sh index c067148a53..739dd149d0 100755 --- a/docs/make-docsite.sh +++ b/docs/make-docsite.sh @@ -18,4 +18,4 @@ echo "Generating HTML pages ..." make html echo "Moving PDF file from $(eval echo $PWD/build/latex/corda-developer-site.pdf) to $(eval echo $PWD/build/html/_static/corda-developer-site.pdf)" -mv $PWD/build/latex/corda-developer-site.pdf $PWD/build/html/_static/corda-developer-site.pdf \ No newline at end of file +mv $PWD/build/latex/corda-developer-site.pdf $PWD/build/html/_static/corda-developer-site.pdf diff --git a/docs/source/release-notes.rst b/docs/source/release-notes.rst index ce7523f4f1..f018ef15b6 100644 --- a/docs/source/release-notes.rst +++ b/docs/source/release-notes.rst @@ -1,9 +1,11 @@ +.. contents:: + Release notes for Corda 4 ========================= .. _release_notes_v4_0: -Here we are, 9 months and 1500 plus commits later... and it's a bouncing baby software release! +Here we are, 10 months and 1500 plus commits later... and it's a bouncing baby software release! We are really proud to release Corda 4 to the open source community today. It's been a long time in the making, but we think you'll agree worth the wait. @@ -24,7 +26,28 @@ apps that benefit from them, *all* nodes in a compatibility zone must be upgrade enforcing that upgrade. This may take time in large zones like the testnet. Please take this into account for your own schedule planning. -.. contents:: + +Important note about Corda’s compatibility, upgrade and interoperability guarantees +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The Corda platform places great emphasis on ensuring compatibility across versions and the ability to +upgrade/migrate data from previous versions to new versions. As a CorDapp developer or operator of a node, +it is important to understand these guarantees and how to take advantage of them. Please see xxx for +full information on Corda’s capabilities and platform commitments. + +For Corda 4, these capabilities will be delivered progressively, across the 4.0 release, which is +available now, and the 4.1 release, which will follow in the coming weeks. Here is how the capability is split: + + *Corda 4.0* delivers the full new suite of Platform version 4 features: Reference states, signature constraints, + and more. See here for a full run-down. The API is stable and you can start developing new apps with it + today and upgrading existing apps to take advantage of the new features today. In addition, you can take these + apps live for new deployments. + + *Corda 4.1* will deliver the ability to support mixed networks of Corda 3.3, Corda Enterprise 3.2 and + Corda 4.1 nodes and the ability to upgrade such nodes, even those with pre-existing data in their vaults to Corda 4.1. + + .. important:: To ensure we maintain our compatibility and data integrity commitments at all times, Corda 4.0 is configured to + refuse to start if it detects that its vault contains any version 3.x data; for such scenarios, please wait for Corda 4.1. Changes for developers in Corda 4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 57e30786dd6b9e89e6781c14dbcb6e75aae3c348 Mon Sep 17 00:00:00 2001 From: Katelyn Baker Date: Thu, 31 Jan 2019 14:09:37 +0000 Subject: [PATCH 2/2] review comments --- docs/source/release-notes.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/source/release-notes.rst b/docs/source/release-notes.rst index f018ef15b6..ceb63fca8c 100644 --- a/docs/source/release-notes.rst +++ b/docs/source/release-notes.rst @@ -1,5 +1,3 @@ -.. contents:: - Release notes for Corda 4 ========================= @@ -23,7 +21,7 @@ comes with those same guarantees. States and apps valid in Corda 3 are transpare Additionally, be aware that the data model upgrades are changes to the Corda consensus rules. To use apps that benefit from them, *all* nodes in a compatibility zone must be upgraded and the zone must be -enforcing that upgrade. This may take time in large zones like the testnet. Please take this into +enforcing that upgrade. This may take time in large zones like the TestNet. Please take this into account for your own schedule planning. @@ -32,19 +30,19 @@ Important note about Corda’s compatibility, upgrade and interoperability guara The Corda platform places great emphasis on ensuring compatibility across versions and the ability to upgrade/migrate data from previous versions to new versions. As a CorDapp developer or operator of a node, -it is important to understand these guarantees and how to take advantage of them. Please see xxx for +it is important to understand these guarantees and how to take advantage of them. Please see :doc:`versioning` for full information on Corda’s capabilities and platform commitments. For Corda 4, these capabilities will be delivered progressively, across the 4.0 release, which is available now, and the 4.1 release, which will follow in the coming weeks. Here is how the capability is split: *Corda 4.0* delivers the full new suite of Platform version 4 features: Reference states, signature constraints, - and more. See here for a full run-down. The API is stable and you can start developing new apps with it + and more. These features are summarised below. The API is stable and you can start developing new apps with it today and upgrading existing apps to take advantage of the new features today. In addition, you can take these apps live for new deployments. - *Corda 4.1* will deliver the ability to support mixed networks of Corda 3.3, Corda Enterprise 3.2 and - Corda 4.1 nodes and the ability to upgrade such nodes, even those with pre-existing data in their vaults to Corda 4.1. + *Corda 4.1* will deliver the ability to support mixed networks of Corda 3.3, Corda Enterprise 3.2 and Corda 4.1 + nodes, and the ability to upgrade such nodes, even those with pre-existing data in their vaults, to Corda 4.1. .. important:: To ensure we maintain our compatibility and data integrity commitments at all times, Corda 4.0 is configured to refuse to start if it detects that its vault contains any version 3.x data; for such scenarios, please wait for Corda 4.1.