ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-24 15:16:45 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Re-organise a part of the versioning discussion into a new toctree section.

Browse Source
This commit is contained in:
Mike Hearn 2019-08-21 12:08:46 +02:00
parent 178814b2d9
commit c7cb6ef725
3 changed files with 24 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/building-a-cordapp-index.rst
View File

@ -12,10 +12,6 @@ CorDapps
cordapp-build-systems cordapp-build-systems
building-against-master building-against-master
debugging-a-cordapp debugging-a-cordapp
versioning
upgrading-cordapps
cordapp-constraint-migration
cordapp-upgradeability
secure-coding-guidelines secure-coding-guidelines
flow-overriding flow-overriding
flow-cookbook flow-cookbook

24
docs/source/corda-api.rst
View File

@ -1,27 +1,3 @@
Corda API
=========
The following are the core APIs that are used in the development of CorDapps:
.. toctree::
:maxdepth: 1
api-states
api-persistence
api-contracts
api-contract-constraints
api-vault-query
api-transactions
api-flows
api-identity
api-service-hub
api-service-classes
api-rpc
api-core-types
api-testing
Before reading this page, you should be familiar with the :doc:`key concepts of Corda <key-concepts>`.
.. _internal-apis-and-stability-guarantees: .. _internal-apis-and-stability-guarantees:
API stability guarantees API stability guarantees

24
docs/source/versioning-and-upgrades.rst Normal file
View File

@ -0,0 +1,24 @@
Versioning and upgrades
=======================
| *Change is inevitable, except from a vending machine*
| -- Abraham Lincoln
|
This section of the guide covers how CorDapps are versioned and how to manage upgrades in a decentralised network. It should be read when
you're at a stage of your development that requires planning for post-launch iteration. You will learn:
* How the ledger expresses to what extent business logic can be changed and by who.
* How change is managed in a world where there are no privileged administrators who can force upgrades.
It's worth planning for versioning and upgrades from the start, especially if you plan for your CorDapp to itself provide APIs to other
apps. Apps extending the platform with industry-specific data models is a common case, and ensuring you can evolve your data model as
the world changes is a key part of any professionally built software.
.. toctree::
:maxdepth: 1
versioning
upgrading-cordapps
cordapp-constraint-migration
cordapp-upgradeability