Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding references and bibliography section #530

Merged
merged 4 commits into from
Dec 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
* Added support for raiseIntent without a context via the addition of the `fdc3.nothing` context type ([#375](https://github.com/finos/FDC3/pull/375))
* Added [**FDC3 Workbench**](https://fdc3.finos.org/toolbox/fdc3-workbench/), an FDC3 API developer application ([#457](https://github.com/finos/FDC3/pull/457))
* Added advice on how to `broadcast` complex context types, composed of other types, so that other apps can listen for both the complex type and simpler constituent types ([#464](https://github.com/finos/FDC3/pull/464))
* Added a References and Bibliography section to the Standard's documentation to hold links to 'normative references' and other documentation that is useful for understanding the standard ([#530](https://github.com/finos/FDC3/pull/530))
* `IntentResolution` now requires the name of the intent raised to included, allowing it to be used to determine the intent raised via `fdc3.raiseIntentForContext()`. ([#507](https://github.com/finos/FDC3/pull/507))

### Changed
Expand Down
31 changes: 31 additions & 0 deletions docs/references.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: References & Bibliography
sidebar_label: References
---


The following normative documents contain provisions, which, through reference in this text, constitute provisions of this Standard. For dated references, subsequent amendments to, or revisions of, any of these publications do not apply. However, parties to agreements based on this Standard are encouraged to investigate the possibility of applying the most recent editions of the normative documents indicated below. For undated references, the latest edition of the normative document referred to applies:

- **Apache 2.0 open-source license**, [https://www.apache.org/licenses/LICENSE-2.0].
- **Community Specification license**, [https://github.com/CommunitySpecification/1.0]
- **JSON Schema**, [https://json-schema.org/].
- **OpenAPI Standard v3.0**, [https://www.openapis.org/].
- **RFC 2119**, _Keywords for use in RFCs to Indicate Requirement Levels, March 1997_, [https://datatracker.ietf.org/doc/html/rfc2119].
- **RFC 2782**, _A DNS RR for specifying the location of services (DNS SRV), February 2000_, [https://datatracker.ietf.org/doc/html/rfc2782].
- **TypeScript Programming Language**, [https://www.typescriptlang.org/].
- **ISO 3166-1**, _Codes for the representation of names of countries and their subdivisions – Part 1: Country codes_, [https://www.iso.org/iso-3166-country-codes.html].
- **ISO 8601-1:2019**, _Date and time — Representations for information interchange — Part 1: Basic rules_, [https://www.iso.org/standard/70907.html]


The following documents may be useful in understanding certain aspects of this Standard; however, knowledge of them is not essential to the creation of a compliant implementation of this Standard:

- **npm**, [https://docs.npmjs.com/about-npm].
- **yarn**, [https://yarnpkg.com/getting-started].
- **pnpm**, [https://pnpm.io/motivation].
- **REST**, [https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm], [https://restfulapi.net/].
- **ISIN**, _International Securities Identification Number_, [https://www.isin.org/isin/]
- **CUSIP**, _Committee on Uniform Security Identification Procedures_, [https://www.cusip.com/identifiers.html#/CUSIP].
- **FIGI**, _Financial Instrument Global Identifier_, [https://www.openfigi.com/about/figi].
- **LEI**, _Legal Entity Identifier based on the ISO 17442 standard_, [https://www.legalentityidentifier.co.uk/what-is-lei-code/].
- **SEDOL**, _Stock Exchange Daily Official List_, [https://www.lseg.com/sedol].
- **PermID**, _Permanent Identifiers_, [https://permid.org/].
3 changes: 2 additions & 1 deletion website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
"supported-platforms",
"why-fdc3",
"fdc3-charter",
"fdc3-compliance"
"fdc3-compliance",
"references"
],
"API": [
"api/overview",
Expand Down