Docs: re-organise the toctree a bit more and introduce a design section

It includes (for now) just the design template.
This commit is contained in:
Mike Hearn 2018-05-11 17:32:19 +02:00
parent 0dd0657194
commit 8cac69d252
10 changed files with 30 additions and 31 deletions

View File

@ -1,5 +1,5 @@
Building a Corda VM from the AWS Marketplace
============================================
AWS Marketplace
===============
To help you design, build and test applications on Corda, called CorDapps, a Corda network AMI can be deployed from the `AWS Marketplace <https://aws.amazon.com/marketplace/pp/B077PG9SP5>`__. Instructions on running Corda nodes can be found `here <https://docs.corda.net/deploying-a-node.html>`_.
@ -12,7 +12,7 @@ Pre-requisites
Deploying a Corda Network
---------------------------
-------------------------
Browse to the `AWS Marketplace <https://aws.amazon.com/marketplace>`__ and search for Corda.

View File

@ -1,5 +1,5 @@
Building a Corda Network on Azure Marketplace
=============================================
Azure Marketplace
=================
To help you design, build and test applications on Corda, called CorDapps, a Corda network can be deployed on the `Microsoft Azure Marketplace <https://azure.microsoft.com/en-gb/overview/what-is-azure>`_

View File

@ -1,5 +1,5 @@
Corda networks
==============
Networks
========
.. toctree::
:maxdepth: 1

View File

@ -1,5 +1,5 @@
Corda nodes
===========
Nodes
=====
.. toctree::
:maxdepth: 1

View File

@ -10,7 +10,7 @@ These should be written in [Markdown](https://github.com/adam-p/markdown-here/wi
## Design Review Process
Please see the [design review process](./designReviewProcess.md).
Please see the [design review process](design-review-process.md).
* Feature request submission
* High level design

View File

@ -1,9 +1,8 @@
# Overview
# Design review process
The Corda Design Review process defines a means of editing, storing, collaborating, reviewing and approving Corda documentation in a consistent, structured, easily accessible and open manner.
# Background
## Background
Historically, Corda design documentation has been produced in an ad hoc fashion to include:
* Multiple sources and formats of storage
@ -20,7 +19,7 @@ Historically, Corda design documentation has been produced in an ad hoc fashion
* Lack of proposed implementation plan (time, resources, effort).
* Often missing stakeholder collaboration and review in the feedback cycle.
# Process
## Process
This process specifies:
@ -53,7 +52,8 @@ The following diagram illustrates the process flow:
![Design Review Process](./designReviewProcess.png)
# Review Groups
## Review Groups
Design documents should include all relevant stakeholders in their distribution (mostly as PR reviewers in github). This will often vary and depend on the origin of the Feature Request, particularly for high level business requirements. Technical Design Documents will tend to include a small set of stakeholders (Design Approval Board, Platform Development, DevOps). Final approval authority lays with at least one member of the Design Approval Board (DAB) or nominated delegate(s).
Design Approval Board (DAB)
@ -91,7 +91,7 @@ Other review groups inlcude:
* Customers
* Key collaborators
# Applicability and Timing
## Applicability and Timing
This process should be applied to any major feature request gathered by the product management team or lead technologists that has been entered in the product backlog as a requirement, and has been prioritized for imminent execution.

View File

@ -2,7 +2,7 @@
# Design Template
Please read the [Design Review Process](../designReviewProcess.md) before completing a design.
Please read the [Design Review Process](../design-review-process.md) before completing a design.
This design template should be used for capturing new Corda feature requests that have been raised as JIRA requirements stories by the product management team. The design may be completed in two stages depending on the complexity and scope of the new feature.

View File

@ -30,7 +30,7 @@ We look forward to seeing what you can do with Corda!
.. _`download the PDF`: _static/corda-developer-site.pdf
.. toctree::
:caption: App development
:caption: Development
:maxdepth: 1
quickstart-index.rst
@ -48,10 +48,21 @@ We look forward to seeing what you can do with Corda!
corda-nodes-index.rst
corda-networks-index.rst
azure-vm.rst
aws-vm.rst
loadtesting.rst
.. toctree::
:caption: Design docs
:maxdepth: 2
design/design-review-process.md
.. toctree::
:caption: Participate
:maxdepth: 2
release-process-index.rst
other-index.rst
corda-repo-layout.rst
building-the-docs.rst
json.rst

View File

@ -1,9 +0,0 @@
Other
=====
.. toctree::
:maxdepth: 1
corda-repo-layout
building-the-docs
json

View File

@ -7,6 +7,3 @@ Tools
network-simulator
demobench
node-explorer
azure-vm
aws-vm
loadtesting