diff --git a/README.md b/README.md index 9972179..17ed0c8 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,27 @@ -# \[Work In Progress\] AMWA NMOS Template Specification +# \[Work In Progress\] AMWA NMOS Transport Mappings -[![Lint Status](https://github.com/AMWA-TV/bcp-template/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/bcp-template/actions?query=workflow%3ALint) -[![Render Status](https://github.com/AMWA-TV/bcp-template/workflows/Render/badge.svg)](https://github.com/AMWA-TV/bcp-template/actions?query=workflow%3ARender) +[![Lint Status](https://github.com/AMWA-TV/bcp-007/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/bcp-007/actions?query=workflow%3ALint) +[![Render Status](https://github.com/AMWA-TV/bcp-007/workflows/Render/badge.svg)](https://github.com/AMWA-TV/bcp-007/actions?query=workflow%3ARender) This repository holds the source for this Specification, part of the family of [Networked Media Open Specifications](https://specs.amwa.tv/nmos) from the [Advanced Media Workflow Association](https://amwa.tv) -### What does it do? +### What does the series do? -- It provides a template for AMWA NMOS Interface Specifcations. +- The BCP-007 series of AMWA Best Common Practices define how to connect Endpoints using AMWA IS-04 and IS-05 for various transports including: + - Specification of the resources and attributes used for the format. + - Requirements for the Transport File (such as SDP). + - Examples. ### Why does it matter? -- It helps ensure consistency between NMOS Specifications. -- It helps us test our continuous integration. +- The individual mapping BCPs ensure consistency between implementations offering NMOS for each stream transport. +- Bringing these together in the BCP-007 series helps provide consistency between the individual mappings and provides an index of mappings. -### How does it work? +### What are the mappings? -- It contains examples of [documentation](docs/), and [examples](examples/) -- It provides a style guide and other advice for specification authors - - This includes how to configure the repo for automatic linting and rendering to `specs.amwa.tv` -- Select `AMWA-TV/bcp-template` as the template when creating the new repo. +- See the [list of BCPs](https://specs.amwa.tv/nmos/#nmos-best-common-practices-bcp) on the main NMOS page. diff --git a/docs/Overview.md b/docs/Overview.md index 70bb142..38b2f9f 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -1,57 +1,15 @@ -# AMWA NMOS Best Common Practice Template: Overview +# AMWA BCP-007 NMOS Transport Mappings: Overview {:.no_toc} * A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above {:toc} -_(c) AMWA 2021, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_ - -![NMOS logo](images/NMOS-logo.png) - -> ## Instructions -> -> **Delete this section after creating a new repo from this template.** -> ->Use this template repo to create a new AMWA NMOS Best Common Practice repo. -> -> Add your content as (GitHub Flavoured) Markdown documents. -> -> - For consistency with other specifications, keep this `Overview.md` but remove these Instructions. -> -> Put diagrams (ideally PNG with encapsulated draw.io source) in the `images/` sub-directory. -> -> Follow the [Style Guide](Style%20Guide.md). -> -> Make a bulleted list of documents in `README.md` in this directory. -> -> Set the repo name used to get the Lint and Render status in the top-level `README.md` (four changes needed). -> -> Set the value of `amwa_id` in `.render/_config.yml` to the AMWA-assigned ID. +_(c) AMWA 2023, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_ ## Introduction -> Provide an overview of the Specification. - -Familiarity with the [JT-NM Reference Architecture](https://jt-nm.org/reference-architecture/) is assumed. - -See also the [NMOS Technical Overview](https://specs.amwa.tv/nmos/main/docs/Technical_Overview.html). - - -## Use of Normative Language - -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", -and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119][RFC-2119]. - -## Definitions - -The NMOS terms 'Node', ... are used as defined in the [NMOS Glossary](https://specs.amwa.tv/nmos/main/docs/Glossary.html). - -> List as appropriate - -This specification also defines the following terms. - -### Example Term +AMWA IS-04/05 and the other NMOS Specifications were originally mostly used in ST 2110 RTP environments, but have always been capable of extension to other streaming transports. BCP-007 is an extensible series of mappings specifying how to use NMOS for individual transports. -Example definition +> BCP-007 is complemented by the BCP-006 series of _format_ mappings. -[RFC-2119]: https://tools.ietf.org/html/rfc2119 "Key words for use in RFCs" +For details of the current set of mappings see the [list of BCPs](https://specs.amwa.tv/nmos/#nmos-best-common-practices-bcp) on the main NMOS page. diff --git a/docs/README.md b/docs/README.md index 3c673bd..a3e4603 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,28 +1,3 @@ - - ### Introduction - [Overview](Overview.md) -- [Style Guide](Style%20Guide.md) - -### Miscellaneous - -- [Further Info](Further%20Info.md) diff --git a/spec.yml b/spec.yml index 790623b..71f385b 100644 --- a/spec.yml +++ b/spec.yml @@ -1,10 +1,9 @@ -amwa_id: BCP-TEMPLATE -url: https://specs.amwa.tv/bcp-template -name: AMWA NMOS Best Common Practice Template -status: Continuing -repo_name: bcp-template -alt_repo_name: nmos-bcp-template -repo_url: https://github.com/AMWA-TV/bcp-template -releases: +amwa_id: BCP-007 +url: https://specs.amwa.tv/bcp-007 +name: Transport Mappings +status: Suite +repo_name: bcp-007 +alt_repo_name: nmos-transport-mappings +repo_url: https://github.com/AMWA-TV/bcp-007 default_branch: main show_in_index: false