ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-21 13:57:54 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
a41ffe7f39
corda/docs/source/index.rst

126 lines
4.1 KiB
ReStructuredText
Raw Normal View History

Refresh for beta release (#819) * Refresh for beta release * Added reference label to Key Concepts * whitespace added after links
2017-06-08 16:15:46 +00:00
Welcome to Corda !
==================
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
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
.. only:: html
Added Corda Whitepaper
2016-08-11 12:57:41 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
`Corda <https://www.corda.net/>`_ is an open-source blockchain platform. If you’d like a quick introduction to blockchains and how Corda is different, then watch this short video:
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
.. raw:: html
Inform users about the newly available Corda training programs at startup and in the docsite.
2017-02-28 15:29:21 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
<embed>
<iframe src="https://player.vimeo.com/video/205410473" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</embed>
Provides clearer instructions on the 'Getting set up' page. Expands 'Troubleshooting' page.
2017-01-31 12:59:24 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
If you want to start coding on Corda, then familiarise yourself with the :doc:`key concepts </key-concepts>`, then read
Rename the new platform white paper back to introductory white paper, because there are still quite a few links to the old name and URL even within our own repository. Reformat docsite slightly to make the white papers more prominent. Also link to the Chinese/Japanese translations of the old paper. Make the build script do both platform/intro and tech white papers.
2019-07-10 13:28:06 +00:00
our :doc:`Hello, World! tutorial </hello-world-introduction>`.
* For the background behind Corda read the `introductory white paper`_ (`Simplified Chinese`_, `Traditional Chinese`_, `Japanese`_).
* For much more architectural detail, the `technical white paper`_.
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
If you have questions or comments, then get in touch on `Slack <https://slack.corda.net/>`_ or ask a question on
`Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_ .
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.
Rename the new platform white paper back to introductory white paper, because there are still quite a few links to the old name and URL even within our own repository. Reformat docsite slightly to make the white papers more prominent. Also link to the Chinese/Japanese translations of the old paper. Make the build script do both platform/intro and tech white papers.
2019-07-10 13:28:06 +00:00
.. _`introductory white paper`: _static/corda-introductory-whitepaper.pdf
.. _`Simplified Chinese`: _static/corda-introductory-whitepaper-zhs.pdf
.. _`Traditional Chinese`: _static/corda-introductory-whitepaper-zht.pdf
.. _`Japanese`: _static/corda-introductory-whitepaper-jp.pdf
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
.. _`technical white paper`: _static/corda-technical-whitepaper.pdf
.. _`download the PDF`: _static/corda-developer-site.pdf
Rename the new platform white paper back to introductory white paper, because there are still quite a few links to the old name and URL even within our own repository. Reformat docsite slightly to make the white papers more prominent. Also link to the Chinese/Japanese translations of the old paper. Make the build script do both platform/intro and tech white papers.
2019-07-10 13:28:06 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
.. only:: latex
Welcome to Corda, a platform for building decentralized applications. This guidebook covers everything you need to know to create
apps, run nodes and networks, and operate your new decentralized business network.
If you're completely new to distributed ledger technology (DLT) or Corda and would like a business-oriented overview, we recommend
reading the introductory white paper. If you'd like a detailed architectural description of how the Corda protocol works, why
it's designed how it is and what future work is planned, we recommend reading the technical white paper. Both white papers can be
found on `the Corda documentation website`_.
Refresh for beta release (#819) * Refresh for beta release * Added reference label to Key Concepts * whitespace added after links
2017-06-08 16:15:46 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
But if you'd like to dive in and start writing apps, or running nodes, this guidebook is for you. It covers the open source Corda
distribution. Commercial distributions (like Corda Enterprise from R3) have their own user guides that describe their enhanced features.
Docs: add link from docsite to api docs
2016-03-08 17:32:13 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
We look forward to seeing what you can do with Corda!
Generate a PDF version of the docsite. Request from a user in Slack.
2018-03-28 14:36:08 +00:00
Improve the PDF by giving the book its own short intro page instead of reusing the HTML intro, which doesn't make sense due to HTML-only markup like videos.
2019-08-21 09:42:08 +00:00
.. _`the Corda documentation website`: https://docs.corda.net
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
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-19 16:12:20 +00:00
.. toctree::
:maxdepth: 1
revision of deploy Signed-off-by: Ed Prosser <edward.prosser@r3.com>
2019-07-02 11:11:36 +00:00
:hidden:
:titlesonly:
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-19 16:12:20 +00:00
release-notes
app-upgrade-notes
Docs: introduce a page about upgrading the node.
2019-02-20 19:38:27 +00:00
node-upgrade-notes
Minor tweaks and improvements in docs TOC to aid navigation and access.
2019-03-26 14:28:18 +00:00
corda-api
cheat-sheet
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-19 16:12:20 +00:00
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::
Docs: re-organise the toctree a bit more and introduce a design section It includes (for now) just the design template.
2018-05-11 15:32:19 +00:00
:caption: Development
Refresh for beta release (#819) * Refresh for beta release * Added reference label to Key Concepts * whitespace added after links
2017-06-08 16:15:46 +00:00
:maxdepth: 1
revision of deploy Signed-off-by: Ed Prosser <edward.prosser@r3.com>
2019-07-02 11:11:36 +00:00
:hidden:
:titlesonly:
Further docsite changes, including reorganising the index.
2017-06-07 15:14:01 +00:00
quickstart-index.rst
key-concepts.rst
building-a-cordapp-index.rst
tutorials-index.rst
tools-index.rst
node-internals-index.rst
component-library-index.rst
[ENT-1955] Documentation fixes (#3417)
2018-06-21 15:57:30 +00:00
serialization-index.rst
Docs: move json to the development section (#3343)
2018-06-11 15:13:45 +00:00
json.rst
[ENT-1955] Documentation fixes (#3417)
2018-06-21 15:57:30 +00:00
troubleshooting.rst
Docs: reorganise the left hand table of contents. It now has an app dev section, an operations section, and a "participate" section.
2018-05-11 15:15:06 +00:00
.. toctree::
:caption: Operations
:maxdepth: 2
revision of deploy Signed-off-by: Ed Prosser <edward.prosser@r3.com>
2019-07-02 11:11:36 +00:00
:hidden:
:titlesonly:
Docs: reorganise the left hand table of contents. It now has an app dev section, an operations section, and a "participate" section.
2018-05-11 15:15:06 +00:00
corda-nodes-index.rst
corda-networks-index.rst
Mention Docker images in the release notes.
2019-01-16 10:30:02 +00:00
docker-image.rst
Docs: re-organise the toctree a bit more and introduce a design section It includes (for now) just the design template.
2018-05-11 15:32:19 +00:00
azure-vm.rst
aws-vm.rst
loadtesting.rst
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 15:37:58 +00:00
cli-application-shell-extensions.rst
Docs: re-organise the toctree a bit more and introduce a design section It includes (for now) just the design template.
2018-05-11 15:32:19 +00:00
[ENT-1955] Documentation fixes (#3417)
2018-06-21 15:57:30 +00:00
.. Documentation is not included in the pdf unless it is included in a toctree somewhere
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 09:05:57 +00:00
Mention Docker images in the release notes.
2019-01-16 10:30:02 +00:00
.. conditional-toctree::
:caption: Corda Network
:maxdepth: 2
:if_tag: htmlmode
revision of deploy Signed-off-by: Ed Prosser <edward.prosser@r3.com>
2019-07-02 11:11:36 +00:00
:hidden:
:titlesonly:
Mention Docker images in the release notes.
2019-01-16 10:30:02 +00:00
corda-network/index.md
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-18 10:56:44 +00:00
corda-network/UAT.md
Mention Docker images in the release notes.
2019-01-16 10:30:02 +00:00
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 09:05:57 +00:00
.. conditional-toctree::
:caption: Contents
:maxdepth: 2
:if_tag: pdfmode
deterministic-modules.rst
release-notes.rst
changelog.rst
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
.. conditional-toctree::
:caption: Participate
:maxdepth: 2
:if_tag: htmlmode
revision of deploy Signed-off-by: Ed Prosser <edward.prosser@r3.com>
2019-07-02 11:11:36 +00:00
:hidden:
:titlesonly:
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
contributing-index.rst
deterministic-modules.rst
Minor tweaks and improvements in docs TOC to aid navigation and access.
2019-03-26 14:28:18 +00:00
design/design-docs-index.rst
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
changelog
Reference in New Issue Copy Permalink