Skip to content

Commit

Permalink
Initial version
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbrightwell committed Nov 14, 2023
1 parent b924cc4 commit 479a5bb
Show file tree
Hide file tree
Showing 11 changed files with 18 additions and 161 deletions.
4 changes: 2 additions & 2 deletions .render/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ plugins:
spec_server: specs.amwa.tv

# AMWA ID
amwa_id: IS-TEMPLATE
amwa_id: IS-DEVICE-CONFIGURATION

# Base name for site (typically lower case version of AMWA ID, or the repo name)
baseurl: /is-template
baseurl: /is-device-configuration

# 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
Expand Down
23 changes: 0 additions & 23 deletions APIs/TemplateAPI.raml

This file was deleted.

27 changes: 0 additions & 27 deletions APIs/schemas/error.json

This file was deleted.

14 changes: 0 additions & 14 deletions APIs/schemas/exampleapi-base.json

This file was deleted.

16 changes: 0 additions & 16 deletions APIs/schemas/id-uuid.json

This file was deleted.

16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
# \[Work In Progress\] AMWA NMOS Template Specification
# \[Work In Progress\] AMWA NMOS Device Configuration Specification

[![Lint Status](https://github.com/AMWA-TV/is-template/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/is-template/actions?query=workflow%3ALint)
[![Render Status](https://github.com/AMWA-TV/is-template/workflows/Render/badge.svg)](https://github.com/AMWA-TV/is-template/actions?query=workflow%3ARender)
[![Lint Status](https://github.com/AMWA-TV/is-device-configuration/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/is-device-configuration/actions?query=workflow%3ALint)
[![Render Status](https://github.com/AMWA-TV/is-device-configuration/workflows/Render/badge.svg)](https://github.com/AMWA-TV/is-device-configuration/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)

<!-- INTRO-START -->

### What does it do?

- It provides a template for AMWA NMOS Interface Specifcations.
- x

### Why does it matter?

- It helps ensure consistency between NMOS Specifications.
- It helps us test our continuous integration.
- x

### How does it work?

- It contains examples of [documentation](docs/), [APIs](APIs/), [schemas](APIs/schemas/), 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/is-template` as the template when creating the new repo.
- x

<!-- INTRO-END -->

Expand Down
3 changes: 0 additions & 3 deletions docs/Further Info.md

This file was deleted.

24 changes: 2 additions & 22 deletions docs/Overview.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,13 @@
# AMWA NMOS Template Specification: Overview
# AMWA NMOS Device Configuration Specification: 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)_
_(c) AMWA 2023, 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 Specification 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.
Expand Down
25 changes: 0 additions & 25 deletions docs/README.md
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)
11 changes: 0 additions & 11 deletions docs/Style Guide.md

This file was deleted.

16 changes: 8 additions & 8 deletions spec.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
amwa_id: IS-TEMPLATE
url: https://specs.amwa.tv/is-template
name: AMWA NMOS Template Specification
status: Continuing
repo_name: is-template
alt_repo_name: nmos-template
repo_url: https://github.com/AMWA-TV/is-template
amwa_id: IS-DEVICE-CONFIGURATION
url: https://specs.amwa.tv/is-device-configuration
name: AMWA NMOS Device Configuration Specification
status: Work In Progress
repo_name: is-device-configuration
alt_repo_name: nmos-device-configuration
repo_url: https://github.com/AMWA-TV/is-device-configuration
releases:
default_branch: main
default_branch: v1.0-dev
show_in_index: false

0 comments on commit 479a5bb

Please sign in to comment.