From 454a75c612c9ee6c66449eab42a31f3b96be85bd Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Fri, 1 Jun 2018 13:35:36 +0200 Subject: [PATCH] Docs: rewrite the front page and re-arrange the enterprise toctree to highlight unique features. --- docs/source/corda-nodes-index.rst | 3 +- docs/source/index.rst | 48 +++++++++++++++++-------------- docs/source/operations-guide.rst | 11 ------- 3 files changed, 27 insertions(+), 35 deletions(-) delete mode 100644 docs/source/operations-guide.rst diff --git a/docs/source/corda-nodes-index.rst b/docs/source/corda-nodes-index.rst index 9f383928c3..da92cdf876 100644 --- a/docs/source/corda-nodes-index.rst +++ b/docs/source/corda-nodes-index.rst @@ -13,5 +13,4 @@ Nodes shell node-database node-administration - out-of-process-verification - hot-cold-deployment + out-of-process-verification \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 358c5232b0..8fdcc5056f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,33 +1,37 @@ -Welcome to Corda ! -================== +Corda Enterprise 3.0 +==================== -`Corda `_ is a blockchain-inspired open source distributed ledger platform. If you’d like a -quick introduction to distributed ledgers and how Corda is different, then watch this short video: +Welcome to the documentation website for **Corda Enterprise 3.0**, based on the Corda 3.1 open source release. Corda Enterprise adds: -.. raw:: html +* High performance, thanks to multi-threaded flow execution and extensive tuning. +* Support for more database backends: - - - + * SQL Server 2017 + * Azure SQL + * Oracle 11g RC2 + * Oracle 12c + * PostgreSQL 9.6 -Want to see Corda running? Download our demonstration application `DemoBench `_ or -follow our :doc:`quickstart guide `. +* The Corda Firewall, for termination of TLS connections within your network's DMZ. +* High availability features to support node-to-node failover. +* Support for advanced database migrations. -If you want to start coding on Corda, then familiarise yourself with the :doc:`key concepts `, then read -our :doc:`Hello, World! tutorial `. For the background behind Corda, read the non-technical -`introductory white paper`_ or for more detail, the `technical white paper`_. +You can learn more in the :doc:`release-notes`. -If you have questions or comments, then get in touch on `Slack `_ or ask a question on -`Stack Overflow `_ . +Corda Enterprise is binary compatible with apps developed for the open source node. This docsite is intended for +administrators and advanced users who wish to learn how to install and configure an enterprise deployment. For +application development please continue to refer to `the main project documentation website `_. -We look forward to seeing what you can do with Corda! +------------ -.. note:: You can read this site offline. Either `download the PDF`_ or download the Corda source code, run ``gradle buildDocs`` and you will have - a copy of this site in the ``docs/build/html`` directory. +.. toctree:: + :caption: Corda Enterprise + :maxdepth: 1 -.. _`introductory white paper`: _static/corda-introductory-whitepaper.pdf -.. _`technical white paper`: _static/corda-technical-whitepaper.pdf -.. _`download the PDF`: _static/corda-developer-site.pdf + hot-cold-deployment + database-migration + corda-bridge-component + bridge-configuration-file .. toctree:: :caption: Development @@ -35,7 +39,6 @@ We look forward to seeing what you can do with Corda! quickstart-index.rst key-concepts.rst - operations-guide.rst building-a-cordapp-index.rst tutorials-index.rst tools-index.rst @@ -53,6 +56,7 @@ We look forward to seeing what you can do with Corda! azure-vm.rst aws-vm.rst loadtesting.rst + certificate-revocation .. toctree:: :caption: Design docs diff --git a/docs/source/operations-guide.rst b/docs/source/operations-guide.rst deleted file mode 100644 index d4d8c04c38..0000000000 --- a/docs/source/operations-guide.rst +++ /dev/null @@ -1,11 +0,0 @@ -Operations Guide -================ - -* :doc:`Database Management ` - -* :doc:`Hot-cold Deployment ` - -* :doc:`Bridge Configuration ` - -* :doc:`Corda Bridge Component Overview ` -