Skip to content

Commit

Permalink
Replace template text with placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
peterbrightwell committed Jan 26, 2024
1 parent 8255c98 commit 254356d
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 41 deletions.
4 changes: 2 additions & 2 deletions .render/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ theme: jekyll-theme-primer
spec_server: specs.amwa.tv

# AMWA ID
amwa_id: INFO-TEMPLATE
amwa_id: NMOS-SENDER-RECEIVER-FRAMEWORK

# Base name for site (typically lower case version of AMWA ID, or the repo name)
baseurl: /info-template
baseurl: /nmos-sender-receiver-framework

# Which release or branch appears in header links and on the home page
default_tree: branches/main # alternatively e.g. releases/v1.0
Expand Down
24 changes: 4 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,11 @@
# \[Work In Progress\] AMWA INFO-TEMPLATE: Template for NMOS Implementation Guides
# \[Work In Progress\] AMWA NMOS Sender Receiver Framework

[![Lint Status](https://github.com/AMWA-TV/info-template/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/info-template/actions?query=workflow%3ALint)
[![Render Status](https://github.com/AMWA-TV/info-template/workflows/Render/badge.svg)](https://github.com/AMWA-TV/info-template/actions?query=workflow%3ARender)
[![Lint Status](https://github.com/AMWA-TV/nmos-sender-receiver-framework/workflows/Lint/badge.svg)](https://github.com/AMWA-TV/nmos-sender-receiver-framework/actions?query=workflow%3ALint)
[![Render Status](https://github.com/AMWA-TV/nmos-sender-receiver-framework/workflows/Render/badge.svg)](https://github.com/AMWA-TV/nmos-sender-receiver-framework/actions?query=workflow%3ARender)

This repository holds the source for this Implementation Guide, 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?

- Provides a template for creating new NMOS Implementation Guides

### Why does it matter?

- NMOS Implementation Guides (INFO-xxx) provide guidance for use of NMOS Specifications.
- Implementation Guides are living documents that are updated to reflect changing technologies.
- This template helps ensure consistency between Implementation Guides.
- It also helps us test our continuous integration.

### How does it work?

- It contains [examples of documentation](docs/) useful in Implementation Guides
- It provides a style guide and other advice for authors
- Select `AMWA-TV/info-template` as the template when creating the new repo
This repo and site will be used for AMWA's forthcoming open-source NMOS Sender Receiver Framework.

<!-- INTRO-END -->
14 changes: 2 additions & 12 deletions docs/Overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# AMWA INFO-TEMPLATE: Template for NMOS Implementation Guides
# AMWA NMOS Sender Receiver Framework
{:.no_toc}

* A markdown unordered list which will be replaced with the ToC, excluding the "Contents header" from above
Expand All @@ -8,14 +8,4 @@ _(c) AMWA 2021, CC Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)_

## Introduction

Write the Implementation Guide using (GitHub Flavoured) Markdown documents.

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.
This repo and site will be used for AMWA's forthcoming open-source NMOS Sender Receiver Framework.
1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
- [Overview](Overview.md)
- [Style Guide](Style%20Guide.md)
12 changes: 6 additions & 6 deletions spec.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
amwa_id: INFO-TEMPLATE
url: https://specs.amwa.tv/info-template
name: Template for NMOS Implementation Guides
amwa_id: SW-SENDER-RECEIVER-FRAMEWORK
url: https://specs.amwa.tv/nmos-sender-receiver-framework
name: NMOS Sender Receiver Framework
status: Continuing
repo_name: info-template
alt_repo_name: nmos-implementation-guide-template
repo_url: https://github.com/AMWA-TV/info-template
repo_name: nmos-sender-receiver-framework
alt_repo_name: nmos-sender-receiver-framework
repo_url: https://github.com/AMWA-TV/nmos-sender-receiver-framework
releases:
default_branch: main
show_in_index: false

0 comments on commit 254356d

Please sign in to comment.