Merge branch 'how-to-submit-a-new-intent' of https://github.com/singl…

…etracksystems/FDC3 into singletracksystems-how-to-submit-a-new-intent

initial commit into FINOS FDC3 branch

CONTRIBUTING.md

@@ -7,17 +7,17 @@ _NOTE:_ Commits and pull requests to FINOS repositories will only be accepted fr
 *Need an ICLA? Unsure if you are covered under an existing CCLA? Email [help@finos.org](mailto:help@finos.org).*
 
 
-## 1.	Contribution Guidelines. 
+## 1.	Contribution Guidelines.
 
 This Working Group accepts contributions via pull requests. The following section outlines the process for merging contributions to the specification
 
-**1.1.	Issues.**  Issues are used as the primary method for tracking anything to do with this specification Working Group. 
+**1.1.	Issues.**  Issues are used as the primary method for tracking anything to do with this specification Working Group.
 
 **1.1.1.	Issue Types.**  A number of issue templates are available in the FDC3 respository:
 
 **1.1.1.1.	Meetings.** Templates for issues that represent meetings and include agendas, teleconference details and minutes.
 
-**1.1.1.2.	Proposals and Enhancement Requests.** Used for items that propose a new ideas or functionality that require a larger discussion. This allows for feedback from others before a specification change is actually written. 
+**1.1.1.2.	Proposals and Enhancement Requests.** Used for items that propose a new ideas or functionality that require a larger discussion. This allows for feedback from others before a specification change is actually written.
 
 **1.1.1.3.	Minor Issue:** These track minor changes or corrections that don't alter the Standard significantly but rather correct minor errors or ommisions.
 
@@ -33,7 +33,7 @@ The issue lifecycle is mainly driven by the Maintainer. All issue types follow t
 
 - The FDC3 Maintainers will apply the proper labels for the issue. This may include labels for priority, type, and metadata.
 
-- (If needed) Clean up the title to succinctly and clearly state the issue. 
+- (If needed) Clean up the title to succinctly and clearly state the issue.
 
 **2.3.	Discussion.**
 
@@ -47,13 +47,13 @@ The issue lifecycle is mainly driven by the Maintainer. All issue types follow t
 
 The Working Group uses pull requests to track changes. To submit a change to the Standard:
 
-**3.1.	Fork the Repo** 
+**3.1.	Fork the Repo**
 - (<https://github.com/finos/FDC3/fork>)
 
 **3.2.	Create your feature branch**
 - `git checkout -b feature/fooBar`
 
-**3.3.	Commit your changes** 
+**3.3.	Commit your changes**
 - `git commit -am 'Describe what you changed'`
 
 **3.4.	Push to the branch**
@@ -62,6 +62,7 @@ The Working Group uses pull requests to track changes. To submit a change to the
 **3.5.	Create a Pull Request**
 - For help creating a pull request from your fork, [see Github's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
 
+To contribute a patch for a New Intent, see the [Submit New Intent](docs/guides/submit-new-intent) guide.
 
 ## 4.	Pull Request Workflow.
 
@@ -78,13 +79,13 @@ The next section contains more information on the workflow followed for Pull Req
 
 **4.2.	Triage**
 
-- The Maintainers will apply the proper labels for the issue. This may include an indication of the subject area or type (e.g. `deprecation`). 
+- The Maintainers will apply the proper labels for the issue. This may include an indication of the subject area or type (e.g. `deprecation`).
 
 **4.3.	Reviewing/Discussion.**
 
 - All PRs will be reviewed by at least one of the FDC3 Maintainers and any appointed Editors. PRs are also open to review by FDC3 Participants.
 
-- The FDC3 Maintainers are responsible for ensuring that the the Standard Working Group has been consulted on either an issue (that provides a high-level of detail on the proposed changes) or on the PR itself, a decision has been reached that the change should be made and that that decision has been documented. 
+- The FDC3 Maintainers are responsible for ensuring that the the Standard Working Group has been consulted on either an issue (that provides a high-level of detail on the proposed changes) or on the PR itself, a decision has been reached that the change should be made and that that decision has been documented.
 
 - All reviews will be completed using the Github review tool.
 

docs/guides/submit-new-intent.md

@@ -0,0 +1,63 @@
+---
+id: SubmitNewIntent
+sidebar_label: How To Submit New Intent
+title: How to Submit a New Intent PR
+---
+
+## Getting Started
+
+Prepare to submit a patch as described in [How to Contribute a Patch](https://github.com/finos/FDC3/blob/master/CONTRIBUTING.md#3how-to-contribute-a-patch) in CONTRIBUTING.md. Use the issue number and issue title as the branch name, e.g.
+
+```git checkout -b 587-intent-proposal-view-research```
+
+To install all the necessary packages to run the website locally, change to the website directory and run yarn
+
+```
+cd website
+yarn
+```
+
+To run the website locally
+
+```yarn start```
+
+This will open the home page or browse to https://localhost:3000
+
+Note that the page opens on the current release version of the docs and you will be changing the latest version. Click the version selector in the top left hand corner
+
+![Version Selector](../assets/version_selector.png)
+
+and then select 'Documentation' under 'Latest Version'
+
+![Latest Version Selector](../assets/latest_version_selector.png)
+
+The 'next' version will be indicated in the header:
+
+![Next Version](../assets/next_version.png)
+
+## Create Intent File
+
+Add the new intent markdown file to docs/intents/ref. Use one of the existing intent markdown files as a template. E.g. the [ViewResearch](../intents/ref/ViewResearch) intent was created using [ViewProfile](../intents/ref/ViewProfile) as an example:
+
+![View Research](../assets/view_research.png)
+
+## Link to Intent File
+
+Add links to your Intent File to the following:
+
+* [src/intents/Intents.ts](https://github.com/finos/FDC3/blob/master/src/intents/Intents.ts)
+* [src/intents/standard intents.json](https://github.com/finos/FDC3/blob/master/src/intents/standard%20intents.json)
+* [website/sidebars.json](https://github.com/finos/FDC3/blob/master/website/sidebars.json) (look for the 'Intents' property and the 'ids' property within it)
+
+At this point your new Intent should appear on the sidebar (you may need to restart yarn to get this).
+
+Also add to:
+
+* [docs/intents/spec.md](https://github.com/finos/FDC3/blob/master/docs/intents/spec.md) in the 'Standard Intents' section (also add the summary from your Intent page)
+* Any of the Context documents in [docs/context/ref](https://github.com/finos/FDC3/blob/master/docs/context/ref) that are utilised by the Intent (e.g. for the [ViewResearch](../intents/ref/ViewResearch) intent, each of the [Contact](../context/ref/Contact), [Instrument](../context/ref/Instrument) and [Organization](../context/ref/Organization) Contexts are valid and so links were added to their Context pages)
+* Any of the Intents documents in [docs/intents/ref](https://github.com/finos/FDC3/blob/master/docs/intents/ref) that are related or relevant to the new Intent (e.g. for the [ViewResearch](../intents/ref/ViewResearch) intent a link was added to the [ViewAnalysis](../intents/ref/ViewAnalysis) document)
+
+## Finishing Off
+
+Commit your changes and push as described in [How to Contribute a Patch](https://github.com/finos/FDC3/blob/master/CONTRIBUTING.md#3how-to-contribute-a-patch). Then submit the branch as a Pull Request (in github, go to the Branches tab and click 'New Pull Request')
+