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
40c1741aba
corda/docs/source/index.rst

112 lines
3.3 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
Reword index page (#3782)
2018-08-14 09:06:30 +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:
Added Corda Whitepaper
2016-08-11 12:57:41 +00:00
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
.. raw:: html
Updates the docs landing page to give clear direction to new users.
2017-01-10 10:18:38 +00:00
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
<embed>
<iframe src="https://player.vimeo.com/video/205410473" width="640" height="360" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</embed>
Inform users about the newly available Corda training programs at startup and in the docsite.
2017-02-28 15:29:21 +00:00
Replaces links to Discourse with Stack Overflow links.
2017-10-30 10:09:08 +00:00
Want to see Corda running? Download our demonstration application `DemoBench <https://www.corda.net/downloads/>`_ or
follow our :doc:`quickstart guide </quickstart-index>`.
Provides clearer instructions on the 'Getting set up' page. Expands 'Troubleshooting' page.
2017-01-31 12:59:24 +00:00
Replaces links to Discourse with Stack Overflow links.
2017-10-30 10:09:08 +00:00
If you want to start coding on Corda, then familiarise yourself with the :doc:`key concepts </key-concepts>`, then read
Reflects tutorial changes and CorDapp build docs changes from release-V1.
2017-11-16 15:31:52 +00:00
our :doc:`Hello, World! tutorial </hello-world-introduction>`. For the background behind Corda, read the non-technical
Updates homepage link. (#4027)
2018-10-04 09:45:55 +00:00
`platform white paper`_ or for more 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
Removes the glossary and FAQ. Points people to StackOverflow for troubleshooting.
2018-03-16 13:41:38 +00:00
If you have questions or comments, then get in touch on `Slack <https://slack.corda.net/>`_ or ask a question on
Replaces links to Discourse with Stack Overflow links.
2017-10-30 10:09:08 +00:00
`Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_ .
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
Adds a link to Hello, Word. Other minor fixes.
2017-06-20 10:26:36 +00:00
We look forward to seeing what you can do with Corda!
Docs: add link from docsite to api docs
2016-03-08 17:32:13 +00:00
Generate a PDF version of the docsite. Request from a user in Slack.
2018-03-28 14:36:08 +00:00
.. 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.
Updates homepage link. (#4027)
2018-10-04 09:45:55 +00:00
.. _`platform white paper`: _static/corda-platform-whitepaper.pdf
Adds a link to Hello, Word. Other minor fixes.
2017-06-20 10:26:36 +00:00
.. _`technical white paper`: _static/corda-technical-whitepaper.pdf
Generate a PDF version of the docsite. Request from a user in Slack.
2018-03-28 14:36:08 +00:00
.. _`download the PDF`: _static/corda-developer-site.pdf
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
release-notes
app-upgrade-notes
Docs: introduce a page about upgrading the node.
2019-02-20 19:38:27 +00:00
node-upgrade-notes
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
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
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
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
contributing-index.rst
deterministic-modules.rst
changelog
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: Design docs
:maxdepth: 2
:if_tag: htmlmode
design/design-review-process.md
design/certificate-hierarchies/design.md
design/failure-detection-master-election/design.md
design/float/design.md
design/hadr/design.md
design/kafka-notary/design.md
design/monitoring-management/design.md
design/sgx-integration/design.md
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 15:29:19 +00:00
design/reference-states/design.md
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
design/sgx-infrastructure/design.md
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 17:48:47 +00:00
design/threat-model/corda-threat-model.md
Add a design doc for signature constraints.
2018-04-17 12:57:51 +00:00
design/data-model-upgrades/signature-constraints.md
Add package namespace ownership design doc to toc tree
2018-10-15 14:01:51 +00:00
design/data-model-upgrades/package-namespace-ownership.md
Docs: add min/target version design doc to the toctree. Refresh versioning doc page.
2018-12-13 12:15:33 +00:00
design/targetversion/design.md
Reference in New Issue Copy Permalink