Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Themes #80

Merged
merged 7 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .render/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

32 changes: 32 additions & 0 deletions .render/_local/_includes/specs_by_theme_table.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<table style="text-align: center">
<thead>
<tr>
<th>Id</th>
<th>Name</th>
<th>Spec Status</th>
{% if include.show_releases %}
<th>Release(s)</th>
{% endif %}
</tr>
</thead>
<tbody>
{% assign specs_to_show = site.data.specs | where_exp:"spec", "spec.themes contains include.filter_theme" | where: "show_in_index", true %}
{% for spec in specs_to_show %}
<tr>
<td><a href="{{ spec.url }}">{{ spec.amwa_id }}</a></td>
<td><a href="{{ spec.url }}">{{ spec.name }}</a></td>
<td>{{ spec.status }}</td>
{% if include.show_releases %}
<td>
{% for release in spec.releases %}
<div>
<a href="{{ spec.url }}/{{ release }}">{{ release }}</a>
<a href="{{ spec.repo_url }}/releases/tag/{{ release }}">↓</a>
</div>
{% endfor %}
</td>
{% endif %}
</tr>
{% endfor %}
</tbody>
</table>
27 changes: 27 additions & 0 deletions .render/_local/_includes/themes_table.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<table style="text-align: center">
<thead>
<tr>
<th>Theme</th>
<th>Description</th>
<th>Members</th>
</tr>
</thead>
<tbody>
{% for theme in site.data.themes %}
<tr>
<!-- <td><a href="{{ spec.url }}">{{ spec.name }}</a></td> -->
<td>{{ theme.name }}</td>
<td>{{ theme.description }}</td>
<td>
{% for member in theme.members %}
<div>
<!-- <a href="{{ spec.url }}/{{ member }}">{{ member }}</a> -->
{{ member }}
{{ site.data.specs[0].amwa_id }}
</div>
{% endfor %}
</td>
</tr>
{% endfor %}
</tbody>
</table>
4 changes: 4 additions & 0 deletions .render/themes.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

{{ site.data.specs | jsonify }}
13 changes: 13 additions & 0 deletions .render/themes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# NMOS Specifications by Theme

The tables below are organised by theme. To see them organised by id, click [here](.)

{% for theme in site.data.themes %}

### {{ theme.name }}

{{ theme.description}}

{% include specs_by_theme_table.html filter_theme=theme.id show_releases=true %}

{% endfor %}
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ The tables below list the current specifications and provide links to their docu

The [NMOS API Testing Tool](https://specs.amwa.tv/nmos-testing) supports the majority of these specifications.

The tables below are organised by specification type. To see them organised by themes, click [here](themes.md)


### [NMOS Interface Specifications (IS)](is/)

These specify NMOS APIs using RAML, JSON Schema and normative text, supported by examples and other text:
Expand Down
13 changes: 13 additions & 0 deletions themes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# NMOS Specifications by Theme

The tables below are organised by theme. To see them organised by id, click [here](.)

{% for theme in site.data.themes %}

### {{ theme.name }}

{{ theme.description}}

{% include specs_by_theme_table.html filter_theme=theme.id show_releases=true %}

{% endfor %}
54 changes: 54 additions & 0 deletions themes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
- id: RESOURCE
name: Resource Management
description: Specifications, recommendations and guidance concerning registration, discovery and labelling of NMOS resources
members:
- IS-04
- IS-09
- IS-13
- BCP-002-01
- BCP-002-02
- INFO-004
- INFO-005

- id: CONNECTION
name: Connection Management
description: Specifications, recommendations and guidance concerning connection of devices, audio channel mapping and compressed streams
members:
- IS-05
- IS-08
- BCP-004-01
- BCP-006-01
- BCP-006-02
- BCP-006-03
- BCP-007-01
- INFO-003
- INFO-005

- id: CONTROL
name: Device Control & Monitoring
description: Specifications, recommendations and guidance concerning device control and status monitoring
members:
- IS-07
- IS-12
- MS-05-01
- MS-05-02
- BCP-008-01
- INFO-006

- id: CONFIGURATION
name: Device Configuration
description: Specifications, recommendations and guidance concerning device and media parameter configuration
members:
- IS-11
- IS-14

- id: SECURITY
name: Security Recommendatations
description: Specifications, recommendations and guidance concerning encryption, authorisation and certificate provisioning
members:
- IS-10
- BCP-003-01
- BCP-003-02
- BCP-003-03
- INFO-002
- INFO-005