From f75ef1bad3e0304b67d35ae9d41a837dc7d4945f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:29:50 +0100 Subject: [PATCH 01/12] Update README.md --- README.md | 27 ++++++++++++++++++++------- 1 file changed, 20 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a9f696e..d48d882 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,25 @@ -# Sofie: The Modern TV News Studio Automation System (NRK Sofie Monitor) +# Sofie Monitor -Basic monitoring service for Sofie servers +This is the _Sofie Monitor_ application of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/). -## Developer information +The _Sofie Monitor_ is a basic monitoring service. -Reads environment variable SOFIE_MONITOR_PORT to set another port than the default -port 3000. Useful when running locally and having sofie-core running at the same time :) +## Developer Information -Set environment variable DEBUG=true to enable debug level logging to the console. +The application reads environment variable `SOFIE_MONITOR_PORT` to set another port than the default +port 3000. Useful when running locally and having [_Sofie Core_](https://github.com/nrkno/sofie-core/) running at the same time. -Set enviroment variable CONTROL_SUB_DEVICES_CONFIG_PATH to the path to the path to the json file defining servers for coreControl. This is set by `yarn watch` to a example file in the repository for easy testing +Set environment variable `DEBUG=true` to enable debug level logging to the console. + +Set enviroment variable `CONTROL_SUB_DEVICES_CONFIG_PATH` to the path of the JSON file defining servers for `coreControl`. This is set by `yarn watch` to a example file in the repository for easy testing. + + +## General Sofie System Information +* [_Sofie_ Documentation](https://nrkno.github.io/sofie-core/) +* [_Sofie_ Releases](https://nrkno.github.io/sofie-core/releases) +* [Contribution Guidelines](CONTRIBUTING.md) +* [License](LICENSE) + +--- + +_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._ From ea29697d10116c53f32500696d057b0f8cc1d2ae Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:32:15 +0100 Subject: [PATCH 02/12] Create CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2df740a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# How to Contribute to this Repository + +Before contributing to this specific repository, please read the [Contribution Guidelines](https://nrkno.github.io/sofie-core/docs/for-developers/contribution-guidelines) for the Sofie project. + + +## Branches +This repository uses the following branches: + +* **_main_** is our main branch. We consider it stable and it is used in production. + +We encourage you to base your contributions on the latest **_main_** branch. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. From c7496078e46f0066231df52047256e4f041752ce Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:37:41 +0100 Subject: [PATCH 03/12] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d48d882..30ae5d4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Sofie Monitor -This is the _Sofie Monitor_ application of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/). +This is the _Sofie Monitor_ application of the [_**Sofie** TV Automation System_](https://github.com/nrkno/Sofie-TV-automation/). The _Sofie Monitor_ is a basic monitoring service. From 1077706e4577cc212cb3255a3fdb1c8a6b9687f3 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:46:18 +0100 Subject: [PATCH 04/12] Create BUG_REPORT.md --- .github/ISSUE_TEMPLATE/BUG_REPORT.md | 38 ++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/BUG_REPORT.md diff --git a/.github/ISSUE_TEMPLATE/BUG_REPORT.md b/.github/ISSUE_TEMPLATE/BUG_REPORT.md new file mode 100644 index 0000000..56355ff --- /dev/null +++ b/.github/ISSUE_TEMPLATE/BUG_REPORT.md @@ -0,0 +1,38 @@ +--- +name: Bug Report +description: Use this if you've found a bug +title: "Bug Report: [Short description of the bug]" +labels: 🐛bug +assignees: '' + +--- + + + +## About Me + + +## Observed Behavior + + +## Expected Behavior + + +## Version + + +## Severity / Impact + + + From 68b77a334ff516289abe213ab23b11bad7899b83 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:46:43 +0100 Subject: [PATCH 05/12] Create OTHER.md --- .github/ISSUE_TEMPLATE/OTHER.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/OTHER.md diff --git a/.github/ISSUE_TEMPLATE/OTHER.md b/.github/ISSUE_TEMPLATE/OTHER.md new file mode 100644 index 0000000..9b597cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/OTHER.md @@ -0,0 +1,22 @@ +--- +name: Other Issue +description: Use this for other issues +title: "Other: [Short description of the issue]" +labels: "Other" +assignees: '' + +--- + + + +## About Me + + +## Issue + From f9bbacfd46e3dd58f41f3c9e57582319f8591ef3 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:47:03 +0100 Subject: [PATCH 06/12] Create QUESTION.md --- .github/ISSUE_TEMPLATE/QUESTION.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/QUESTION.md diff --git a/.github/ISSUE_TEMPLATE/QUESTION.md b/.github/ISSUE_TEMPLATE/QUESTION.md new file mode 100644 index 0000000..39d6f48 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/QUESTION.md @@ -0,0 +1,22 @@ +--- +name: Question +description: Use this if you have a question to the Sofie team +title: "Question: [Short summary of the question]" +labels: ❓ Question +assignees: '' + +--- + + + +## About Me + + +## My Question + From 51a007982461b582c2352725cd4dee9c14914cbd Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:47:27 +0100 Subject: [PATCH 07/12] Create RFC.md --- .github/ISSUE_TEMPLATE/RFC.md | 46 +++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/RFC.md diff --git a/.github/ISSUE_TEMPLATE/RFC.md b/.github/ISSUE_TEMPLATE/RFC.md new file mode 100644 index 0000000..4cc485c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/RFC.md @@ -0,0 +1,46 @@ +--- +name: Request for Comments +description: Use this to initiate a discussion about a new feature or a larger change +title: "RFC: [Short description of the feature/change]" +labels: RFC, Contribution +assignees: '' + +--- + + + +## About Me + + +## Background + + + +## Proposal + + + +## Status + + +The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week. + +- [x] RFC created +- [ ] Sofie Team has evaluated the RFC +- [ ] A workshop has been planned +- [ ] RFC has been discussed in a workshop +- [ ] A conclusion has been reached, see comments in thread. From 6126fdfd067f2af08c809ceb975c671ad3dab014 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:48:14 +0100 Subject: [PATCH 08/12] Create PULL-REQUEST-TEMPLATE.md --- .github/PULL-REQUEST-TEMPLATE.md | 46 ++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 .github/PULL-REQUEST-TEMPLATE.md diff --git a/.github/PULL-REQUEST-TEMPLATE.md b/.github/PULL-REQUEST-TEMPLATE.md new file mode 100644 index 0000000..a5a5ec7 --- /dev/null +++ b/.github/PULL-REQUEST-TEMPLATE.md @@ -0,0 +1,46 @@ +--- +name: Request for Comments +description: Use this to initiate a discussion about a new feature or a larger change +title: "RFC: [Short description of the feature/change]" +labels: RFC, Contribution +assignees: '' + +--- + + + +## About Me + + +## Background + + + +## Proposal + + + +## Status + + +The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week. + +- [x] RFC created. +- [ ] Sofie Team has evaluated the RFC. +- [ ] A workshop has been planned. +- [ ] RFC has been discussed in a workshop. +- [ ] A conclusion has been reached, see comments in thread. From 9d00c210e2e98e079e6c5c81400a0e897d4accaf Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 10:49:46 +0100 Subject: [PATCH 09/12] Update LICENSE --- LICENSE | 26 +------------------------- 1 file changed, 1 insertion(+), 25 deletions(-) diff --git a/LICENSE b/LICENSE index 311fee9..91982cc 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License - Copyright (c) 2019 Norsk rikskringkasting (NRK) + Copyright (c) 2023 Norsk rikskringkasting (NRK) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,27 +19,3 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - ---- - - MIT License - - Copyright (c) Microsoft Corporation. All rights reserved. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE From d3ff164635c0d12acf086aa693582ade8462dbc0 Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 12:52:20 +0100 Subject: [PATCH 10/12] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2df740a..06c3395 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,6 @@ Before contributing to this specific repository, please read the [Contribution G ## Branches This repository uses the following branches: -* **_main_** is our main branch. We consider it stable and it is used in production. +* We consider the **_main_** branch to be stable and it is used in production. We encourage you to base your contributions on the latest **_main_** branch. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases. From e245e97523ec62c1ae8c58751ec2edf71bb92a6a Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 12:59:06 +0100 Subject: [PATCH 11/12] Update PULL-REQUEST-TEMPLATE.md --- .github/PULL-REQUEST-TEMPLATE.md | 62 ++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/.github/PULL-REQUEST-TEMPLATE.md b/.github/PULL-REQUEST-TEMPLATE.md index a5a5ec7..92803e9 100644 --- a/.github/PULL-REQUEST-TEMPLATE.md +++ b/.github/PULL-REQUEST-TEMPLATE.md @@ -1,46 +1,56 @@ ---- -name: Request for Comments -description: Use this to initiate a discussion about a new feature or a larger change -title: "RFC: [Short description of the feature/change]" -labels: RFC, Contribution -assignees: '' - ---- - -## About Me +## About the Contributor -## Background + +## Type of Contribution + +This is a: + +Bug fix / Feature / Code improvement / Documentation improvement / Other (please specify) + + +## Current Behavior -## Proposal +## New Behavior -## Status +## Testing Instructions -The Sofie Team will evaluate this RFC and open up a discussion about it, usually within a week. -- [x] RFC created. -- [ ] Sofie Team has evaluated the RFC. -- [ ] A workshop has been planned. -- [ ] RFC has been discussed in a workshop. -- [ ] A conclusion has been reached, see comments in thread. +## Other Information + + + +## Status + + +- [ ] PR is ready to be reviewed. +- [ ] The functionality has been tested by the author. +- [ ] Relevant unit tests has been added / updated. +- [ ] Relevant documentation (code comments, [system documentation](https://nrkno.github.io/sofie-core/)) has been added / updated. From f8fd18092d1aa8ca7bd296b6a53ca9f08a17e86f Mon Sep 17 00:00:00 2001 From: Jonas Hummelstrand Date: Thu, 7 Dec 2023 13:10:59 +0100 Subject: [PATCH 12/12] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 06c3395..9391e3f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,6 @@ Before contributing to this specific repository, please read the [Contribution G ## Branches This repository uses the following branches: -* We consider the **_main_** branch to be stable and it is used in production. +* We consider the **_main_** branch to be stable, and it is used in production. We encourage you to base your contributions on the latest **_main_** branch. The [_Sofie Releases_](https://nrkno.github.io/sofie-core/releases) page collects the status and timeline of the releases.