feat: improved documentation site and release process

.travis.yml

@@ -0,0 +1,43 @@
+language: node_js
+node_js:
+  - 8
+
+env:
+  global:
+    # travis encrypt GITHUB_USERNAME=....
+    # travis encrypt GITHUB_PASSWORD=....
+    # travis encrypt GH_TOKEN=....
+    # travis encrypt NPM_TOKEN=...
+    # - secure: ""
+
+
+deploy:
+  # TODO - enable it when ready to release
+  - provider: script
+    skip_cleanup: true
+    script: npm run semantic-release
+    on:
+      branch: master
+  - provider: script
+    skip_cleanup: true
+    # TODO - replace maoo/fdc3-pages-layout with FDC3/FDC3, as soon as code is contributed
+    script: curl https://raw.githubusercontent.com/maoo/FDC3/common-docs-layout/docs/prepare-docs-release.sh | bash
+    on:
+      branch: master
+  - provider: pages
+    skip-cleanup: true
+    github-token: $GH_TOKEN
+    email: $GITHUB_EMAIL
+    name: $GITHUB_USERNAME
+    verbose: true
+    keep-history: true
+    local-dir: gh-pages-docs
+    target_branch: gh-pages
+    on:
+      branch: master
+
+# TODO - enable it when ready to release
+# notifications:
+#   email:
+#     - fdc3-api@finos.org
+#     - announce@finos.org

README.md

@@ -1,9 +1,6 @@
 # ContextData
-Context data object specifications, schemas, and examples:
 
-* Extending APIs from one App to another is powerful...
-* However, it requires building to a specific API ahead of time
-* Standard context and intent definitions let us create workflows on the fly
+Context data object specifications, schemas, and examples.
 
 FDC3 Context Data defines a standard way to pass common identifiers and data between apps to create a seamless workflow.  FDC3 Context Data is not a symbology solution and is not specifically focused on modeling financial objects.  The focus is on providing a standard payload structure that can be used to establish a lowest common denominator for interoperability.
 

docs/CNAME

@@ -0,0 +1 @@
+fdc3-context-data.finos.org

docs/_config.yml

@@ -0,0 +1,36 @@
+title: FDC3 ContextData specifications
+
+description: The documentation website for the FINOS FDC3 ContextData specifications
+
+google_analytics: UU-123456
+
+show_downloads: false
+
+github:
+  is_project_page: true
+  repository_url: https://github.com/fdc3/ContextData
+
+version: '[[tag]]'
+
+collections:
+- tags
+
+links:
+  - name: Getting Started
+    url: /
+  - name: API specs
+    url: /specs
+  - name: FDC3 ContextData Working Group
+    url: https://finosfoundation.atlassian.net/wiki/spaces/FDC3/pages/85393412/Context+Data+Working+Group
+    target: _blank
+  - name: FDC3 Program
+    url: https://finos.org/fdc3
+    target: _blank
+
+social_icons:
+  - name: github
+    image_url: "https://www.finos.org/hs-fs/hubfs/FINOS/website/logos/social-logos/github-logo-black.png?t=1539813516681&width=48&height=48&name=github-logo.png"
+    link_url: https://github.com/fdc3/ContextData
+  - name: confluence
+    image_url: "https://www.finos.org/hs-fs/hubfs/sofin%20assets/External%20logos/atlassian-logo.png?width=48&height=48&name=atlassian-logo.png"
+    link_url: https://finosfoundation.atlassian.net/wiki/spaces/FDC3/pages/85393412/Context+Data+Working+Group

docs/index.md

@@ -0,0 +1,40 @@
+---
+layout: default
+---
+
+# ContextData
+Context data object specifications, schemas, and examples
+
+* Extending APIs from one App to another is powerful...
+* However, it requires building to a specific API ahead of time
+* Standard context and intent definitions let us create workflows on the fly
+
+FDC3 Context Data defines a standard way to pass common identifiers between apps to create a seamless workflow.  FDC3 Context Data is not a symbology solution and is not focused on modeling financial objects.  The focus is on providing a standard envelope and a standard set of identifiers that can be used to set a lowest common denominator for interop.
+
+## Context Envelope Structure
+```javascript
+{
+object: (string) //object type
+definition: (string) //url
+version: (string) //version # (semver)
+data: (array) //the context payload
+}
+```
+## Example Context Object
+```javascript
+{ “object” : ”fdc3-context”,
+  “definition” : ” https://fdc3.org...”,
+  “version” : ”1.0.0”,
+  “data” : [ 
+    { 
+      “type” : ”security”,
+      “name” : ”Apple”,
+      “id” : {
+        “ticker” : ”aapl”,
+        “ISIN” : “US0378331005”,
+        “CUSIP” : “037833100”,
+        “FIGI” : ”BBG000B9XRY4”,
+        “default“ : “aapl”
+    }}
+]}
+```

Specification-Draft.MD → docs/specs.md

@@ -1,3 +1,7 @@
+---
+layout: default
+---
+
 # FDC3 Context Data #
 
 ## Context Data Overview ##

examples/sampleContact.json

@@ -0,0 +1,48 @@
+{
+    "objectType": "fdc3-context",
+    "definition": "https://fdc3.org/ContextSchema.json",
+    "version": "0.0.2",
+    "contextItems": [
+        {
+        "displayName": "Fred Smith",
+        "displayType": "Contact",
+        "data": [
+            {
+                "format": "fdc3.Contact",
+                "version": "0.0.1",
+                "itemData": {
+                    "firstName": "Fred",
+                    "lastName": "Smith",
+                    "email": "fred@smith.com"                       
+                }
+            },
+            {
+                "format": "com.symphony.Contact",
+                "version": "0.0.1",
+                "itemData": {
+                    "name": "Fred Smith",
+                    "org":"Independent",
+                    "symphonyhandle": "fred-smith42"                        
+                }
+            },
+            {
+                "format": "com.microsoft.Outlook.Contact",
+                "version": "0.0.1",
+                "itemData": {
+                    "firstName": "Fred",
+                    "lastName": "Smith",
+                    "email": "fred@smith.com",
+                    "outlookId": "12345678"                       
+                }
+            },
+            {
+                "format": "custom.tick42.demo.Contact",
+                "version": "0.0.1",
+                "itemData": {
+                    "!!!!": ""                        
+                }
+            }
+        ] 
+    }
+    ]
+  }

examples/sampleInstrument.json

@@ -0,0 +1,57 @@
+{
+    "objectType": "fdc3-context",
+    "definition": "https://fdc3.org/ContextSchema.json",
+    "version": "0.0.2",
+    "contextItems": [
+        {
+        "displayName": "Apple",
+        "displayType": "Equity",
+        "data": [
+            {
+                "format": "fdc3.security",
+                "version": "0.0.1",
+                "itemData": {
+                    "ISIN": "",
+                    "CUSIP": "",
+                    "BBG": "",
+                    "SEDOL": "",
+                    "ticker": "",
+                    "com.factset.symbology.entity":"",
+                    "com.factset.symbology.regionalticker": ""                        
+                }
+            },
+            {
+                "format": "com.factset.security",
+                "version": "0.0.1",
+                "itemData": {
+                    "ticker": "",
+                    "symbology.entity":"",
+                    "regionalticker": ""                        
+                }
+            },
+            {
+                "format": "com.openfigi.Equity",
+                "version": "0.0.1",
+                "itemData": {
+                    "Name": "Apple Inc",
+                    "Ticker":"AAPL",
+                    "ExchangeCode": "XN",
+                    "FIGI": "BBG000N89284",
+                    "FIGI Composite": "BBG000N88V36",
+                    "SecurityType": "Equity.CommonStock"
+                }
+            },
+            {
+                "format": "custom.tick42.demo.Instrument",
+                "version": "0.0.1",
+                "itemData": {
+                    "marketDataSource": "Reuters",
+                    "Ticker":"AAPL",
+                    "marketDataTicker": "AAPL.N",
+                    "demoInstrumentId": "567890"  
+                }
+            }
+        ]
+        }
+    ]
+  }