refactoring ausdigital/ausdigital.github.io#33

ausdigital · Feb 6, 2017 · 24c0b74 · 24c0b74
1 parent 720d8e8
commit 24c0b74
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 30 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,16 @@
-# Transaction Access Point Specification
+# AusDigital Transaction Access Point (TAP) Specification
 
 The access point, usually provided by the ledger vendor, is the service gateway for a given business and so hosts the end-point to which business documents are sent.  The gateway is an avaialbility mediator (allowing specific businesses to have intermittent connectivity) and is responsible for signature validation and submitting transactions to the notary service.
 
-See full documentation at [https://ausdigital-tap.readthedocs.io/](https://ausdigital-tap.readthedocs.io/)
+* [Version 1.0](/docs/1.0/index.md)
+* [Version 2.0](/docs/2.0/index.md)
+
+Specification: [https://ausdigital-tap.readthedocs.io/](https://ausdigital-tap.readthedocs.io/)
+
+Community discussion/support: [ausdigital.org](http://ausdigital.org)
+
+Open source reference implementation: [https://github.com/test-point/testpoint-tap/](https://github.com/test-point/testpoint-tap)
+
+Test suite: [https://github.com/test-point/testpoint-tap](https://github.com/test-point/testpoint-tap)
+
+Live test endpoint: [https://tap.testpoint.io/](https://tap.testpoint.io/)
diff --git a/docs/1.0/index.md b/docs/1.0/index.md
@@ -5,31 +5,43 @@
 
 ## AusDigital Transaction Access Point (TAP) 1.0 Specification
 
+## Introduction
+
 This document describes a protocol for exchanging formal documents (such as invoices) between businesses. TAP is a secure, decentralised, peer to peer architecture where gateways are optional and minimally trusted.
 
-## Overview
+## Goals
 
-The Access Point Implementation Guide defines the standards for delivering and receiving of digital business documents within the Council’s Interoperability Framework (Framework). The Framework defines the following components:
-* Access Point: A sender or receiver of digital business documents;
-* Digital Capability Locator: A service for looking up the location of the Digital Capability Publisher for a Participant. (Digital Business Council, 2016a);
-* Digital Capability Publisher: A service for Participants to store details of their capabilities, and includes what scenarios they can process, the data formats they support and the delivery address for their eInvoices. (Digital Business Council, 2016b); and
-* Electronic Business Documents: A digital representation of a business document, e.g. an eInvoice.
+The primary goal of the Transaction Access Point (TAP) 1.0 Specification is to TBA.
 
-![Figure 1: Context of Access Points within the Interoperability Framework](./tap_business_context_diagram.png "Figure 1: Context of Access Points within the Interoperability Framework")
+The Transaction Access Point (TAP) 1.0 Specification defines TBA.
 
-Figure 1: Context of Access Points within the Interoperability Framework
 
-The messaging protocol described in this document is business process and business document agnostic. The underlying OASIS ebMS3 standard has been designed to be flexible and support a large number of use cases. This implementation guide reduces complexity by focusing on the exchange of business documents regardless of their type or the process in which they are used.
+## Status
 
-The context diagram Figure 1 shows the components included in the Interoperability Framework and where the Access Point (AP) sits. The Digital Capability Publisher and Digital Capability Locator are used by the Access Points and enable the eInvoicing process.
+This spec is an early draft for consuiltation.
 
-The components of the framework are used in a four-corner model (see Figure 2: Four Corner Model). End users, or participants, don’t directly exchange electronic information but connect through a network of Access Points. The digital address for a receiving Access Point is dynamically discovered using the Digital Capability Locator (DCL) and Digital Capability Publisher(DCP) components of the Framework. Access Points may also update a participant’s digital endpoint in the DCP.
+This specification aims to support the Australian Digital Business Council
+[eInvoicing initiative](http://ausdigital.org), and is under active
+development at
+[https://github.com/ausdigital/ausdigital-tap](https://github.com/ausdigital/ausdigital-tap).
 
-![Figure 2: Four Corner Model](./tap_four_corner_model.png "Figure 2: Four Corner Model")
+Comments and feedback are encouraged and welcome. Pull requests with improvements are welcome too.
 
-Figure 2: Four Corner Model
 
-See the complete [Access Point Implementation Guide](./Access_Point_Implementation_Guide_v1.0.pdf) for further details.
+## Glossary
+
+Phrase | Definition
+------------ | -------------
+ausdigital-tap/1 | This specification.
+ausdigital-dcl/1 | Version 1 of the AusDigtial [Digital Capability Locator (DCL)](https://ausdigital-dcl.readthedocs.io) specification
+ausdigital-idp/1 | Version 1 of the AusDigital [Identity Provider (IDP)](https://ausdigital-idp.readthedocs.io) specification.
+ausdigital-dcp/1 | Version 1 of the AusDigital [Digital Capability Publisher (DCP)](http://ausdigital.org/transaction-access-point) specification.
+ausdigital-tap/2 | Version 2 of the AusDigital [Transaction Access Point(TAP)](http://ausdigital.org/transaction-access-point) specification.
+ausdigital-nry/1 | Version 1 of the AusDigital [Notary (NRY)](http://ausdigital.org/notary/) specification.
+
+The TAP service depends on TBA and TBA.
+
+Other TBA and TBA services both depend on the TAP service.
 
 ## Licence
 
@@ -47,3 +59,36 @@ This document is governed by the [2/COSS](http://rfc.unprotocols.org/spec:2/COSS
 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT",
 "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in
 RFC 2119.
+
+
+## Overview
+
+The Access Point Implementation Guide defines the standards for delivering and receiving of digital business documents within the Council’s Interoperability Framework (Framework). The Framework defines the following components:
+* Access Point: A sender or receiver of digital business documents;
+* Digital Capability Locator: A service for looking up the location of the Digital Capability Publisher for a Participant. (Digital Business Council, 2016a);
+* Digital Capability Publisher: A service for Participants to store details of their capabilities, and includes what scenarios they can process, the data formats they support and the delivery address for their eInvoices. (Digital Business Council, 2016b); and
+* Electronic Business Documents: A digital representation of a business document, e.g. an eInvoice.
+
+![Figure 1: Context of Access Points within the Interoperability Framework](./tap_business_context_diagram.png "Figure 1: Context of Access Points within the Interoperability Framework")
+
+Figure 1: Context of Access Points within the Interoperability Framework
+
+The messaging protocol described in this document is business process and business document agnostic. The underlying OASIS ebMS3 standard has been designed to be flexible and support a large number of use cases. This implementation guide reduces complexity by focusing on the exchange of business documents regardless of their type or the process in which they are used.
+
+The context diagram Figure 1 shows the components included in the Interoperability Framework and where the Access Point (AP) sits. The Digital Capability Publisher and Digital Capability Locator are used by the Access Points and enable the eInvoicing process.
+
+The components of the framework are used in a four-corner model (see Figure 2: Four Corner Model). End users, or participants, don’t directly exchange electronic information but connect through a network of Access Points. The digital address for a receiving Access Point is dynamically discovered using the Digital Capability Locator (DCL) and Digital Capability Publisher(DCP) components of the Framework. Access Points may also update a participant’s digital endpoint in the DCP.
+
+![Figure 2: Four Corner Model](./tap_four_corner_model.png "Figure 2: Four Corner Model")
+
+Figure 2: Four Corner Model
+
+See the complete [Access Point Implementation Guide](./Access_Point_Implementation_Guide_v1.0.pdf) for further details.
+
+# Related Material
+
+ * AusDigital Transaction Access Point Implementation Guide (v1.0, available [here](https://github.com/ausdigital/ausdigital-tap/blob/master/docs/1.0/Digital_Capability_Publisher_Implementation_Guide_v1.0.pdf)), which provides background to the [AusDigital](http://ausdigital.org) community process.
+ * [GitHub issues](https://github.com/ausdigital/ausdigital-tap/issues/) for collaborating on the development of the TAP.
+ * A reference [TAP service](https://tap.testpoint.io/) (for testing and development purposes).
+ * Free, Open-Source Software [TAP implementation](https://github.com/test-point/testpoint-tap).
+ * An automated [TAP test suite](https://github.com/test-point/testpoint-tap).
diff --git a/docs/2.0/index.md b/docs/2.0/index.md
@@ -3,28 +3,45 @@
  * Editor: Chris Gough
  * Contributors: Steve Capell
 
-## AusDigtial Transaction Access Point (TAP) 2.0 Specification
+# AusDigtial Transaction Access Point (TAP) 2.0 Specification
+
+## Introduction
+
+This document describes a protocol for exchanging formal documents (such as invoices)
+between businesses. TAP is a secure, decentralised, peer to peer architecture where gateways
+are optional and minimally trusted.
+
+## Goals
+
+The primary goal of the Transaction Access Point (TAP) 2.0 Specification is to TBA.
+
+The Transaction Access Point (TAP) 2.0 Specification defines TBA.
+
+
+## Status
+
+This spec is an early draft for consuiltation.
+
+This specification aims to support the Australian Digital Business Council
+[eInvoicing initiative](http://ausdigital.org), and is under active
+development at
+[https://github.com/ausdigital/ausdigital-tap](https://github.com/ausdigital/ausdigital-tap).
+
+Comments and feedback are encouraged and welcome. Pull requests with improvements are welcome too.
+
 
 ## Glossary:
 
 phrase | Definition
 ------------ | -------------
 ausdigital-tap/2 | Version 2 of the [AusDigtial](http://ausdigital.org) [TAP](http://ausdigital-tap.readthedocs.io/) specification
-ausdigital-tapgw/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [TAPGW](http://ausdigital-tap-gw.readthedocs.io/) specification
+ausdigital-tapgw/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [TAP-GW](http://ausdigital-tap-gw.readthedocs.io/) specification
 ausdigital-bill/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [BILL](http://ausdigital-bill.readthedocs.io/) specification
 ausdigital-dcl/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [DCL](http://ausdigital-dcl.readthedocs.io/) specification
 ausdigital-dcp/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [DCP](http://ausdigital-dcp.readthedocs.io/) specification
 ausdigital-nry/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [NRY](http://ausdigital-nry.readthedocs.io/) specification
 ausdigital-idp/1 | Version 1 of the [AusDigtial](http://ausdigital.org) [IDP](http://ausdigital-idp.readthedocs.io/) specification
 
-This document describes a protocol for exchanging formal documents (such as invoices)
-between businesses. TAP is a secure, decentralised, peer to peer architecture where gateways
-are optional and minimally trusted.
-
-This specification aims to support the Australian Digital Business Council
-[eInvoicing initiative](https://ausdigital.org), and is under active development
-at [https://github.com/ausdigital/ausdigital-tap](https://github.com/ausdigital/ausdigital-tap).
-
 
 ## Licence
 
@@ -358,4 +375,12 @@ References
 
  * Normative References
  * Informative References
-
+
+
+# Related Material
+
+ * AusDigital Transaction Access Point Implementation Guide (v1.0, available [here](https://github.com/ausdigital/ausdigital-tap/blob/master/docs/1.0/Digital_Capability_Publisher_Implementation_Guide_v1.0.pdf)), which provides background to the [AusDigital](http://ausdigital.org) community process.
+ * [GitHub issues](https://github.com/ausdigital/ausdigital-tap/issues/) for collaborating on the development of the TAP.
+ * A reference [TAP service](https://tap.testpoint.io/) (for testing and development purposes).
+ * Free, Open-Source Software [TAP implementation](https://github.com/test-point/testpoint-tap).
+ * An automated [TAP test suite](https://github.com/test-point/testpoint-tap).
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,3 @@
-# AusDigital Transaction Access Point Specification
- * [Version 1.0](/docs/1.0/index.md)
- * [Version 2.0](/docs/2.0/index.md)
+# AusDigital Transaction Access Point (TAP) Specification
+ * [Version 1.0](/1.0)
+ * [Version 2.0](/2.0)