Merge pull request #9 from rikoe/adding-finos-docs

Adding files from FINOS Blueprint

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct for FDC3
+
+Please see the [Community Code of Conduct](https://www.finos.org/code-of-conduct).

.github/CONTRIBUTING.md

@@ -0,0 +1,89 @@
+# Contributing to FDC3
+:+1: First off, thanks for taking the time to contribute! :+1:
+
+# Contributor License Agreement (CLA)
+A CLA is a document that specifies how a project is allowed to use your
+contribution; they are commonly used in many open source projects.
+
+**_All_ contributions to _all_ projects hosted by [FINOS](https://www.finos.org/)
+must be made with a
+[Foundation CLA](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/83034172/Contribute)
+in place, and there are [additional legal requirements](https://finosfoundation.atlassian.net/wiki/spaces/FINOS/pages/75530375/Legal+Requirements)
+that must also be met.**
+
+As a result, PRs submitted to the FDC3 project cannot be accepted until you have a CLA in place with the Foundation.
+
+# Contributing Issues
+
+## Prerequisites
+
+* [ ] Have you [searched for duplicates](https://github.com/FDC3/FDC3/issues?utf8=%E2%9C%93&q=)?  A simple search for exception error messages or a summary of the unexpected behaviour should suffice.
+* [ ] Are you running the latest version?
+* [ ] Are you sure this is a bug or missing capability?
+
+## Raising an Issue
+* Create your issue [here](https://github.com/FDC3/FDC3/issues/new).
+* New issues contain two templates in the description: bug report and enhancement request. Please pick the most appropriate for your issue, **then delete the other**.
+  * Please also tag the new issue with either "Bug" or "Enhancement".
+* Please use [Markdown formatting](https://help.github.com/categories/writing-on-github/)
+liberally to assist in readability.
+  * [Code fences](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for exception stack traces and log entries, for example, massively improve readability.
+
+# Contributing Pull Requests (Code & Docs)
+To make review of PRs easier, please:
+
+ * Please make sure your PRs will merge cleanly - PRs that don't are unlikely to be accepted.
+ * For code contributions, follow the existing code layout.
+ * For documentation contributions, follow the general structure, language, and tone of the [existing docs](https://github.com/FDC3/FDC3/wiki).
+ * Keep commits small and cohesive - if you have multiple contributions, please submit them as independent commits (and ideally as independent PRs too).
+ * Reference issue #s if your PR has anything to do with an issue (even if it doesn't address it).
+ * Minimise non-functional changes (e.g. whitespace shenanigans).
+ * Ensure all new files include a header comment block containing the [Apache License v2.0 and your copyright information](http://www.apache.org/licenses/LICENSE-2.0#apply).
+ * If necessary (e.g. due to 3rd party dependency licensing requirements), update the [NOTICE file](https://github.com/FDC3/FDC3/blob/master/NOTICE) with any new attribution or other notices
+
+
+## Commit and PR Messages
+
+* **Reference issues, wiki pages, and pull requests liberally!**
+* Use the present tense ("Add feature" not "Added feature")
+* Use the imperative mood ("Move button left..." not "Moves button left...")
+* Limit the first line to 72 characters or less
+* Please start the commit message with one or more applicable emoji:
+
+| Emoji | Raw Emoji Code | Description |
+|:---:|:---:|---|
+| :tada: | `:tada:` | **initial** commit |
+| :construction: | `:construction:` | **WIP** (Work In Progress) commits |
+| :ambulance: | `:ambulance:` | when fixing a **bug** |
+| :bug: | `:bug:` | when **identifying a bug**, via an inline comment (please use the `@FIXME` tag in the comment) |
+| :new: | `:new:` | when introducing **new** features |
+| :art: | `:art:` | when improving the **format** / structure of the code |
+| :pencil: | `:pencil:` | when **performing minor changes / fixing** the code or language |
+| :ballot_box_with_check: | `:ballot_box_with_check:` | when completing a task |
+| :arrow_up: | `:arrow_up:` | when upgrading **dependencies** |
+| :arrow_down: | `:arrow_down:` | when downgrading **dependencies** |
+| :racehorse: | `:racehorse:` | when improving **performance** |
+| :fire: | `:fire:` | when **removing code** or files |
+| :speaker: | `:speaker:` | when adding **logging** |
+| :mute: | `:mute:` | when reducing **logging** |
+| :books: | `:books:` | when writing **docs** |
+| :bookmark: | `:bookmark:` | when adding a **tag** |
+| :gem: | `:gem:` | new **release** |
+| :zap: | `:zap:` | when introducing **backward incompatible** changes or **removing functionality** |
+| :bulb: | `:bulb:` | new **idea** identified in the code, via an inline comment (please use the `@IDEA` tag in the comment) |
+| :snowflake: | `:snowflake:` | changing **configuration** |
+| :lipstick: | `:lipstick:` | when improving **UI** / cosmetic |
+| :umbrella: | `:umbrella:` | when adding **tests** |
+| :green_heart: | `:green_heart:` | when fixing the **CI** build |
+| :lock: | `:lock:` | when dealing with **security** |
+| :shirt: | `:shirt:` | when removing **linter** / strict / deprecation / reflection warnings |
+| :fast_forward: | `:fast_forward:` | when **forward-porting features** from an older version/branch |
+| :rewind: | `:rewind:` | when **backporting features** from a newer version/branch |
+| :wheelchair: | `:wheelchair:` | when improving **accessibility** |
+| :globe_with_meridians: | `:globe_with_meridians:` | when dealing with **globalisation** / internationalisation |
+| :rocket: | `:rocket:` | anything related to deployments / **DevOps** |
+| :non-potable_water: | `:non-potable_water:` | when plugging memory leaks
+| :penguin: | `:penguin:` | when fixing something on **Linux** |
+| :apple: | `:apple:` | when fixing something on **Mac OS** |
+| :checkered_flag: | `:checkered_flag:` | when fixing something on **Windows** |
+| :handbag: | `:handbag:` | when a commit contains multiple unrelated changes that don't fit into any one category (but please try not to do this!) |

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,24 @@
+---
+name: 🐛 Bug Report
+about: If something isn't working as expected 🤔.
+
+---
+
+## Bug Report
+
+### Steps to Reproduce:
+ 1. ...step 1 description...
+ 2. ...step 2 description...
+ 3. ...step 3 description...
+
+### Expected Result:
+...description of what you expected to see...
+
+### Actual Result:
+...what actually happened, including full exceptions (please include the entire stack trace, including "caused by" entries), log entries, screen shots etc. where appropriate...
+
+### Environment:
+...version and build of the project, OS and runtime versions, virtualised environment (if any), etc. ...
+
+### Additional Context:
+...add any other context about the problem here. If applicable, add screenshots to help explain...

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: 🚀 Feature Request
+about: I have a suggestion (and may want to implement it 🙂)!
+
+---
+
+## Feature Request
+
+### Description of Problem:
+...what *problem* are you trying to solve that the project doesn't currently solve?
+
+...please resist the temptation to describe your request in terms of a solution.  Job Story form ("When [triggering condition], I want to [motivation/goal], so I can [outcome].") can help ensure you're expressing a problem statement.
+
+### Potential Solutions:
+...clearly and concisely describe what you want to happen. Add any considered drawbacks.
+
+... if you've considered alternatives, clearly and concisely describe those too.

.github/ISSUE_TEMPLATE/Support_question.md

@@ -0,0 +1,11 @@
+---
+name: 🤗 Support Question
+about: If you have a question about configuration, usage, etc. 💬
+
+---
+
+## Support Question
+
+...ask your question here.
+
+...be sure to search existing issues since someone might have already asked something similar.

LICENSE

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
+      boilerplate notice, with the fields enclosed by brackets "{}"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2017 FDC3
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE.spdx

@@ -0,0 +1,7 @@
+SPDXVersion: SPDX-2.0
+DataLicense: CC0-1.0
+Creator: FDC3
+PackageName: FDC3
+PackageOriginator: FDC3
+PackageHomePage: https://github.com/FDC3/FDC3
+PackageLicenseDeclared: Apache-2.0

NOTICE

@@ -0,0 +1,5 @@
+FDC3 - FINOS
+Copyright 2017 FDC3 [email protected]
+
+This product includes software developed at the Fintech Open Source Foundation (https://www.finos.org/).
+

README.md

@@ -1,121 +1,35 @@
-# Example Single FDC3 Repository and Website
+Badges go here (see [shields.io](https://shields.io/), for examples).
 
-[![Build Status](https://travis-ci.com/rikoe/FDC3.svg?branch=master)](https://travis-ci.com/rikoe/FDC3)
 [![FINOS - Incubating](https://cdn.rawgit.com/finos/contrib-toolbox/master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)
 
-This repository demonstrates using [Docusaurus](https://docusaurus.io) to author and host the FDC3 website and documentation, based on markdown files.
+Open standards for the financial desktop - https://FDC3.github.io/FDC3
 
-## Plan
+# FDC3
 
-- [x] Try out Docusaurus
-- [x] Host on GitHub Pages
-- [x] Attempt to apply styling and assets from https://fdc3.finos.org to this website
-- [x] Copy docs from other FDC3 repositories into this single repository
-- [x] Setup CI
-- [ ] Copy code/examples from other FDC3 repositories
-- [x] Add docs from use cases
-- [ ] Integrate OpenAPI docs for app directory (redoc?)
-- [ ] Integrate generated TS docs for API
-- [ ] API reference (postponing)
-- [ ] Intent reference
-- [ ] Versioning
-- [ ] About page
-- [ ] Community page
-- [ ] Extra documentation content
-- [ ] Tutorial content (after 1.0)
-- [ ] FINOS/Working group info
-- [ ] Finalise styling and assets
-- [ ] GitHub README must adhere to FINOS standard
-- [ ] Present to PMC
+The mission of the Financial Desktop Connectivity and Collaboration Consortium (FDC3) is to develop specific protocols and taxonomies to advance the ability of desktop applications in financial workflows to interoperate in a plug-and-play fashion and without prior, bi-lateral agreements.
 
-For more detail, see the [FINOS FDC3 1.0 Release Public Launch Documentation Sub-Plan](https://finosfoundation.atlassian.net/wiki/spaces/FDC3/pages/711950361/FDC3+1.0+Release+Public+Launch+Documentation+Sub-Plan).
+## Installation
 
-## Developer Information
+FDC3 is a standard and as such has no direct install.
+Check out the [reference implementations](link to come) for actual code to install. 
 
-The included example website was generated by following the [Docusaurus installation steps](https://docusaurus.io/docs/en/installation).
+## Usage example
 
-### Required tools
+Check out how FDC3 is [being used](link to usage examples)
 
-* NodeJS 8+ [[Install](https://nodejs.org/en/download/)]
-* Yarn 1.5+ [[Install](https://yarnpkg.com/lang/en/docs/install/)]
 
-### Structure
+## Contributing
 
-The repository follows the standard Docusaurus website structure. For more information, see [Creating your site](https://docusaurus.io/docs/en/site-creation).
-Propose to move the working group github sites under the same structure to simplify
+1. Fork it (<https://github.com/yourname/yourproject/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
 
-```
-root-directory
-├── docs
-└── website
-    ├── blog
-    ├── core
-    │   └── Footer.js
-    ├── package.json
-    ├── pages
-    ├── sidebars.json
-    ├── siteConfig.js
-    └── static
-└── src
-    ├── api
-    ├── app-directory
-    ├── context
-    ├── intents
-└── examples
-    ├── context
-    ├── intents
-```
+## License
 
-### Running the website locally
+Copyright 2017 FDC3
 
-1. Navigate to the `website` folder:
-   ```
-   cd website
-   ```
+Distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 
-2. Install pre-requisites (first time only)
-   ```
-   yarn
-   ```
-
-3. Run the local web server: 
-   ```
-   yarn start
-   ```
-
-4. Navigate to the website: http://localhost:3000
-
-### Publishing to GitHub Pages
-
-The following properties were added to `website/siteConfig.js`:
-
-```js
-const siteConfig = {
-    url: 'https://rikoe.github.io',
-    baseUrl: '/FDC3/',
-    projectName: 'FDC3',
-    organizationName: 'rikoe'
-}
-```
-
-To publish the website, follow this steps:
-
-1. Navigate to the `website` folder:
-   ```
-   cd website
-   ```
-
-2. Publish: 
-   ```
-    GIT_USER=<GIT_USER> USE_SSH=true yarn run publish-gh-pages
-   ```
-
-This will publish to the `gh-pages` branch of the repository, which will automatically be hosted on GitHub Pages.
-
-### Continuous Integration
-
-The CI build is hosted on Travis CI at https://travis-ci.com/rikoe/FDC3. When new changes are committed to `master`, Travis will automatically deploy an updated version of the website to GitHub Pages.
-
-> For full documentation about publishing Docusaurus websites, see [Publishing your site](https://docusaurus.io/docs/en/publishing).
-
-> For more information about GitHub Pages, see [GitHub's FAQ](https://help.github.com/articles/user-organization-and-project-pages/).
+SPDX-License-Identifier: [Apache-2.0](https://spdx.org/licenses/Apache-2.0)