diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..5e3fdcd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** +- OS: (e.g. iOS) +- Browser (e.g. chrome, safari) +- Version (e.g. 22) + +**Smartphone (please complete the following information):** +- Device: (e.g. iPhone6) +- OS: (e.g. iOS8.1) +- Browser (e.g. stock browser, safari) +- Version (e.g. 22) + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..04458c2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,10 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..35cedfc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when... + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/sample_issue_form.yml b/.github/ISSUE_TEMPLATE/sample_issue_form.yml new file mode 100644 index 0000000..df68035 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/sample_issue_form.yml @@ -0,0 +1,15 @@ +name: Sample form +description: Create an issue. +title: "[Bug]: " +labels: [bug] +assignees: + - octocat +body: + - type: input + id: sample-input + attributes: + label: Sample Input + description: Write text here. + placeholder: Here will be text + validations: + required: true diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..8ce1b10 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,11 @@ +name: Lint +on: [push, pull_request, workflow_dispatch] +jobs: + lint: + runs-on: ubuntu-latest + name: Lint + steps: + - name: Use NMOS Lint + uses: docker://amwa/nmos-lint:latest + env: + GITHUB_BRANCH: ${{ github.ref_name }} diff --git a/.github/workflows/open_issue.yml b/.github/workflows/open_issue.yml new file mode 100644 index 0000000..b2f59e8 --- /dev/null +++ b/.github/workflows/open_issue.yml @@ -0,0 +1,15 @@ +name: Open Issue +on: + issues: + types: + - opened + +jobs: + label_issue: + runs-on: ubuntu-latest + steps: + - env: + GITHUB_TOKEN: ${{ github.token }} + ISSUE_URL: ${{ github.event.issue.html_url }} + run: | + gh issue edit $ISSUE_URL --add-label "triage" diff --git a/.github/workflows/render.yml b/.github/workflows/render.yml new file mode 100644 index 0000000..5b38f7a --- /dev/null +++ b/.github/workflows/render.yml @@ -0,0 +1,25 @@ +name: Render +on: + workflow_dispatch: + + push: + branches: + - 'v[0-9]+.[0-9]+-dev' + - 'v[0-9]+.[0-9]+.x' + - 'publish-*' + tags: + - 'v[0-9]+.[0-9]+' + - 'v[0-9]+.[0-9]+.[0-9]+' + release: +jobs: + build: + runs-on: ubuntu-latest + name: Build + steps: + - name: Use NMOS Render + uses: docker://amwa/nmos-render:latest + env: + SSH_HOST: ${{ secrets.SSH_HOST }} + SSH_USER: ${{ secrets.SSH_USER }} + SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }} + SSH_KNOWN_HOSTS: ${{ secrets.SSH_KNOWN_HOSTS }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aa14556 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +*# +*.swp +*~ +.DS_Store diff --git a/.lint/.gitignore b/.lint/.gitignore new file mode 100644 index 0000000..c2ff133 --- /dev/null +++ b/.lint/.gitignore @@ -0,0 +1,10 @@ +*# +*.swp +*~ +.DS_Store +.scripts/ +node_modules/ +npm-debug.log +package-lock.json +package.json +yarn.lock diff --git a/.lint/.init-scripts/make-build-tools.sh b/.lint/.init-scripts/make-build-tools.sh new file mode 100755 index 0000000..744f70a --- /dev/null +++ b/.lint/.init-scripts/make-build-tools.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +set -o errexit + +git clone --single-branch --branch main https://${GITHUB_TOKEN:+${GITHUB_TOKEN}@}github.com/AMWA-TV/nmos-lint-scripts .scripts +.scripts/install-dependencies.sh diff --git a/.lint/.init-scripts/make-distclean.sh b/.lint/.init-scripts/make-distclean.sh new file mode 100755 index 0000000..3a2e36c --- /dev/null +++ b/.lint/.init-scripts/make-distclean.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +set -o errexit + +rm -rf package.json node_modules/ yarn.lock package-lock.json .scripts/ diff --git a/.lint/Makefile b/.lint/Makefile new file mode 100644 index 0000000..7f521b3 --- /dev/null +++ b/.lint/Makefile @@ -0,0 +1,9 @@ +-include .scripts/scripts.mk + +.PHONY: build-tools distclean + +build-tools: + .init-scripts/make-build-tools.sh + +distclean: + .init-scripts/make-distclean.sh diff --git a/.render/.gitignore b/.render/.gitignore new file mode 100644 index 0000000..dabace6 --- /dev/null +++ b/.render/.gitignore @@ -0,0 +1,24 @@ +*# +*.swp +*~ +.DS_Store +.layouts/ +.sass-cache/ +.scripts/ +Gemfile.lock +/_layouts/ +/_includes/ +/assets/ +/_data/ +_site/ +*.json +branches/ +index.md +node_modules/ +npm-debug.log +package-lock.json +package.json +releases/ +raml2html-nmos-theme/ +source-repo/ +yarn.lock diff --git a/.render/.init-scripts/make-build-tools.sh b/.render/.init-scripts/make-build-tools.sh new file mode 100755 index 0000000..2f9ac6e --- /dev/null +++ b/.render/.init-scripts/make-build-tools.sh @@ -0,0 +1,6 @@ +#!/bin/bash + +set -o errexit + +git clone --single-branch --branch "${NMOS_DOC_BUILD_SCRIPTS_BRANCH:-main}" https://${GITHUB_TOKEN:+${GITHUB_TOKEN}@}github.com/AMWA-TV/nmos-render-scripts .scripts +.scripts/install-dependencies.sh diff --git a/.render/.init-scripts/make-distclean.sh b/.render/.init-scripts/make-distclean.sh new file mode 100755 index 0000000..315fe7d --- /dev/null +++ b/.render/.init-scripts/make-distclean.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +set -o errexit + +rm -f index.md index-contents.md +rm -rf source-repo/ branches/ releases/ +rm -rf .scripts/ .layouts/ _layouts/ assets/ raml2html-nmos-theme/ _site/ .ssh/ +rm -rf node_modules/ +rm -f yarn.lock package.json package-lock.json Gemfile.lock diff --git a/.render/Gemfile b/.render/Gemfile new file mode 100644 index 0000000..5e5d999 --- /dev/null +++ b/.render/Gemfile @@ -0,0 +1,3 @@ +source 'https://rubygems.org' +gem 'github-pages', group: :jekyll_plugins +gem 'faraday', '~>0' diff --git a/.render/Makefile b/.render/Makefile new file mode 100644 index 0000000..7f521b3 --- /dev/null +++ b/.render/Makefile @@ -0,0 +1,9 @@ +-include .scripts/scripts.mk + +.PHONY: build-tools distclean + +build-tools: + .init-scripts/make-build-tools.sh + +distclean: + .init-scripts/make-distclean.sh diff --git a/.render/_config.yml b/.render/_config.yml new file mode 100644 index 0000000..bbc4abd --- /dev/null +++ b/.render/_config.yml @@ -0,0 +1,18 @@ +# Don't change these +remote_theme: pages-themes/primer +plugins: +- jekyll-remote-theme +spec_server: specs.amwa.tv + +# AMWA ID +amwa_id: BCP-TEMPLATE + +# Base name for site (typically lower case version of AMWA ID, or the repo name) +baseurl: /bcp-template + +# Which release or branch appears in header links and on the home page +default_tree: branches/v1.0-dev # alternatively e.g. releases/v1.0 + +# Regex patterns of releases and branches to show +show_releases: ^v[0-9]+\.[0-9]+$|^v[0-9]+\.[0-9]+\.[0-9]+$ +show_branches: ^v[0-9]+\.[0-9]+-dev$|^v[0-9]+\.[0-9]+\.x$|^publish- diff --git a/.render/spec.json b/.render/spec.json new file mode 100644 index 0000000..494d29f --- /dev/null +++ b/.render/spec.json @@ -0,0 +1,4 @@ +--- +--- + +{{ site.data.spec | jsonify }} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1850b96 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog +This document provides an overview of changes between released versions of this specification. + +## Release v1.0 +* Initial release diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..595a24d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +Thanks for your interest in this AMWA NMOS Specification. + +AMWA Specifications (including Best Current Practices) are developed and ratified in accordance with +AMWA's Specification Process. See BCP-001 on the [AMWA Specifications page](https://www.amwa.tv/specifications) + +They are created and updated in AMWA working groups, requiring AMWA membership for participation. + +AMWA member contributions to this Specification are made subject to AMWA's [IPR Policy](https://www.amwa.tv/about/policies/AMWA_IPR_Policy_V3.0.pdf). +Contributions should be accompanied by the form in an appendix of that policy. + +For more information for those wishing to develop or contribute to AMWA NMOS Specifications, +please see the NMOS [Wiki Page](https://github.com/amwa-tv/nmos/wiki/Maintainers) for maintainers. + +## Reporting Issues + +AMWA members and non-members are welcome to raise issues via the GitHub Issues tab. + +## Pull Requests + +We accept Pull Requests from AMWA members participating in relevant workgroups. These are subject to the IPR Policy. + +Please read about our [GitHub Workflow](https://github.com/amwa-tv/nmos/wiki/GitHub-Workflow) before creating a pull request, +in particular the 'Maintaining a Specification' section, as we try to maintain a consistent approach to branches and releases. +This should indicate which branch it is most appropriate to create your pull request against. + +Each NMOS workgroup has a number of members that will review a PR. + +## Suggesting Improvements or Enhancements + +We are interested in hearing of suggestions, both for the spec itself and the accompanying documentation. +Please use the issue tracker or [contact AMWA](https://www.amwa.tv/contact). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..414c073 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 AMWA + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..88da569 --- /dev/null +++ b/NOTICE @@ -0,0 +1,10 @@ +THIS AMWA SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, +AND IN PARTICULAR, ANY WARRANTY OF NON-INFRINGEMENT IS EXPRESSLY DISCLAIMED. +ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S +OWN RISK, AND NEITHER AMWA, NOR ANY OF ITS MEMBERS OR CONTRIBUTORS, SHALL +HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY +DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE +USE OF THIS SPECIFICATION. + +Readers are advised that any IPR contribution forms associated with this +project are available from the [AMWA](http://amwa.tv/) diff --git a/README.md b/README.md new file mode 100644 index 0000000..9972179 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# \[Work In Progress\] AMWA NMOS Template Specification + +[![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) + +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? + +- It provides a template for AMWA NMOS Interface Specifcations. + +### Why does it matter? + +- It helps ensure consistency between NMOS Specifications. +- It helps us test our continuous integration. + +### How does it work? + +- 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. + + + +## Getting started + +There is more information about the NMOS Specifications and their GitHub repos at . diff --git a/docs/Further Info.md b/docs/Further Info.md new file mode 100644 index 0000000..429fa5e --- /dev/null +++ b/docs/Further Info.md @@ -0,0 +1,3 @@ +# Further Information + +This file is here for testing automation. Look at the main NMOS page for more information on NMOS! diff --git a/docs/Overview.md b/docs/Overview.md new file mode 100644 index 0000000..70bb142 --- /dev/null +++ b/docs/Overview.md @@ -0,0 +1,57 @@ +# AMWA NMOS Best Common Practice Template: 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. + +## 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 + +Example definition + +[RFC-2119]: https://tools.ietf.org/html/rfc2119 "Key words for use in RFCs" diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3c673bd --- /dev/null +++ b/docs/README.md @@ -0,0 +1,28 @@ + + +### Introduction + +- [Overview](Overview.md) +- [Style Guide](Style%20Guide.md) + +### Miscellaneous + +- [Further Info](Further%20Info.md) diff --git a/docs/Style Guide.md b/docs/Style Guide.md new file mode 100644 index 0000000..631bb5d --- /dev/null +++ b/docs/Style Guide.md @@ -0,0 +1,7 @@ +# Style Guide + +Be careful with normative and non-normative language. + +It may be better to put lengthy guidance in a separate implementation guide. + +Markdown will be linted, so try to keep consistent with what is in this template and what is in other specs. See for details. diff --git a/docs/images/NMOS-logo.png b/docs/images/NMOS-logo.png new file mode 100644 index 0000000..f831307 Binary files /dev/null and b/docs/images/NMOS-logo.png differ diff --git a/docs/images/README.md b/docs/images/README.md new file mode 100644 index 0000000..4bffe21 --- /dev/null +++ b/docs/images/README.md @@ -0,0 +1 @@ +This directory is for images used in documentation diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..e1ba1d1 --- /dev/null +++ b/examples/README.md @@ -0,0 +1 @@ +This directory is for examples diff --git a/examples/example.json b/examples/example.json new file mode 100644 index 0000000..cb9a54a --- /dev/null +++ b/examples/example.json @@ -0,0 +1,3 @@ +{ + "example": 123 +} diff --git a/spec.yml b/spec.yml new file mode 100644 index 0000000..790623b --- /dev/null +++ b/spec.yml @@ -0,0 +1,10 @@ +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: +default_branch: main +show_in_index: false