diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..ceaf1b9 --- /dev/null +++ b/.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: docs-pages + - 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: docs-pages + - 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: docs-pages + +# TODO - enable it when ready to release +# notifications: +# email: +# - fdc3-intents@finos.org +# - announce@finos.org \ No newline at end of file diff --git a/README.md b/README.md index 32a5b8c..6a53e00 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,5 @@ # Intents -FDC3 Intents 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 Intents specifications, schemas, and examples. -FDC3 Intents define a standard set of verbs that can be used to put together common cross-application workflows on the financial desktop. -* Applications register the intents & context combination they support -* The registries support app discovery by intents and/or context -* Intents are not full RPC, Apps don’t need to enumerate every function with an intent -* FDC3 Standard intents are a limited set, organizations can create their own intents - -## Using Intents -Combined with FDC3 Context Data and App Directory standards, Intents enable rich service discovery on the the desktop. For example: - -**Directing a market data platform to show a chart** -```javascript -fdc3.open("my-platform","ViewChart",{ - object:"fdc3-context", - version:"0.0.1", - definition:"https://fdc3/schema/context/0.0.1", - data:[ - { - type:"instrument", - name:"IBM", - id:{ - ticker:"ibm" - } -} ]}); -``` - -**Discovering an app that can start a chat** -```javascript -fdc3.open(null,"StartChat",{ - object:"fdc3-context", - version:"0.0.1", - definition:"https://fdc3/schema/context/0.0.1", - data:[ - { - type:"contact", - name:"Nick Kolba", - id:{ - email:"nick@openfin.co" - } -} ]}); -``` - -**Discovering apps that have intents for context type "contact"** -```javascript -let availableContactHandlers = fdc3.resolve(null,"contact"); -``` \ No newline at end of file +Visit [fdc3-intents.finos.org](https://fdc3-intents.finos.org) for more info. \ No newline at end of file diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 0000000..26509f2 --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +fdc3-intents.finos.org \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..10354f7 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,33 @@ +title: FDC3 Intents specifications + +description: The documentation website for the FINOS FDC3 Intents specifications + +google_analytics: UU-123456 + +show_downloads: false + +github: + is_project_page: true + repository_url: https://github.com/fdc3/Intents + +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 + +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/Intents + - 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/83984435/Intents+Working+Group \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..a0cd10e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,57 @@ +--- +layout: default +--- + +# Intents + +FDC3 Intents 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 Intents define a standard set of verbs that can be used to put together common cross-application workflows on the financial desktop. +* Applications register the intents & context combination they support +* The registries support app discovery by intents and/or context +* Intents are not full RPC, Apps don’t need to enumerate every function with an intent +* FDC3 Standard intents are a limited set, organizations can create their own intents + +## Using Intents +Combined with FDC3 Context Data and App Directory standards, Intents enable rich service discovery on the the desktop. For example: + +**Directing a market data platform to show a chart** +```javascript +fdc3.open("my-platform","ViewChart",{ + object:"fdc3-context", + version:"0.0.1", + definition:"https://fdc3/schema/context/0.0.1", + data:[ + { + type:"instrument", + name:"IBM", + id:{ + ticker:"ibm" + } +} ]}); +``` + +**Discovering an app that can start a chat** +```javascript +fdc3.open(null,"StartChat",{ + object:"fdc3-context", + version:"0.0.1", + definition:"https://fdc3/schema/context/0.0.1", + data:[ + { + type:"contact", + name:"Nick Kolba", + id:{ + email:"nick@openfin.co" + } +} ]}); +``` + +**Discovering apps that have intents for context type "contact"** +```javascript +let availableContactHandlers = fdc3.resolve(null,"contact"); +``` \ No newline at end of file diff --git a/Specification-Draft.MD b/docs/specs.md similarity index 99% rename from Specification-Draft.MD rename to docs/specs.md index 5c81db0..9c0dabc 100644 --- a/Specification-Draft.MD +++ b/docs/specs.md @@ -1,4 +1,9 @@ +--- +layout: default +--- + # FDC3 Intents Specification - Draft # + ## FDC3 Intents Overview ## FDC3 Intents define a standard set of nouns and verbs that can be used to put together common cross-application workflows on the financial desktop. diff --git a/package.json b/package.json new file mode 100644 index 0000000..63f15bd --- /dev/null +++ b/package.json @@ -0,0 +1,35 @@ +{ + "name": "fdc3-intents", + "main": "index.js", + "repository": "https://github.com/maoo/Intents.git", + "license": "Apache-2.0", + "scripts": { + "semantic-release": "semantic-release" + }, + "devDependencies": { + "semantic-release": "^15.10.3", + "@semantic-release/changelog": "^3.0.1", + "@semantic-release/git": "^7.0.5" + }, + "release": { + "branch": "docs-pages", + "plugins": [ + "@semantic-release/commit-analyzer", + "@semantic-release/release-notes-generator", + "@semantic-release/git", + [ + "@semantic-release/changelog", + { + "changelogFile": "docs/CHANGELOG.md.new" + } + ], + [ + "@semantic-release/npm", + { + "npmPublish": false + } + ], + "@semantic-release/github" + ] + } +}