generated from AMWA-TV/bcp-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6d476ba
commit 610d591
Showing
4 changed files
with
24 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,3 @@ | ||
<!-- | ||
Use this file to specify an ordered and leveled markdown list the documents that need to be rendered | ||
This list will be rendered at "https://specs.amwa.tv/<spec>/<version>/docs/" | ||
- Use a "-" bullet character for each document, indented as you want it to appear in the list, followed by a space | ||
- Follow that with the name to display, in square brackets | ||
- Follow that immediately by then the document filename, in round parentheses | ||
- Include the ".md" | ||
- Don't include the "docs/" | ||
- Escape any spaces with "%20" (this is needed so links work on github.com) | ||
- Don't use document numbers (this was previous practice for NMOS docs) | ||
- Other text and headings can be included. Level-3 headings ("###") work best. | ||
- The display name and filename don't need to match (see IS-04 for examples of this). | ||
- All documents that need rendering must be listed. | ||
See https://github.com/AMWA-TV/nmos-template/docs/README.md for an example of the syntax | ||
--> | ||
|
||
### Introduction | ||
|
||
- [Overview](Overview.md) | ||
- [Style Guide](Style%20Guide.md) | ||
|
||
### Miscellaneous | ||
|
||
- [Further Info](Further%20Info.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |