From a3d242c3a5cae7675ceacc170cf4502c481b6d85 Mon Sep 17 00:00:00 2001 From: Kris West Date: Tue, 21 Dec 2021 15:15:03 +0000 Subject: [PATCH 1/3] Adding references and bibliography section --- docs/references.md | 31 +++++++++++++++++++++++++++++++ website/sidebars.json | 3 ++- 2 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/references.md diff --git a/docs/references.md b/docs/references.md new file mode 100644 index 000000000..15aac5430 --- /dev/null +++ b/docs/references.md @@ -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]. +- **RFC2782**, _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/]. \ No newline at end of file diff --git a/website/sidebars.json b/website/sidebars.json index 55ec50018..fb59b33f9 100644 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -5,7 +5,8 @@ "supported-platforms", "why-fdc3", "fdc3-charter", - "fdc3-compliance" + "fdc3-compliance", + "references" ], "API": [ "api/overview", From abc36db0df8830c40b1d762d35ebc9f4c23d9df0 Mon Sep 17 00:00:00 2001 From: Kris West Date: Tue, 21 Dec 2021 16:23:03 +0000 Subject: [PATCH 2/3] changelog --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cfbf2dee0..0ca31077a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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)) ### Changed * Consolidated `Listener` documentation with other types ([#404](https://github.com/finos/FDC3/pull/404)) From b7fc21f4233441ef9889c047ada70ad52952878d Mon Sep 17 00:00:00 2001 From: Kris West Date: Tue, 21 Dec 2021 17:21:47 +0000 Subject: [PATCH 3/3] be consistent over the formatting of RFC numbers --- docs/references.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/references.md b/docs/references.md index 15aac5430..22d10895f 100644 --- a/docs/references.md +++ b/docs/references.md @@ -11,7 +11,7 @@ The following normative documents contain provisions, which, through reference i - **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]. -- **RFC2782**, _A DNS RR for specifying the location of services (DNS SRV), February 2000_, [https://datatracker.ietf.org/doc/html/rfc2782]. +- **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]