Skip to content

Commit 1518b3b

Browse files
authored
chore: update dev docs (Sofie-Automation#1552)
* chore: update some wording in dev docs * chore: update some old links
1 parent ef95f7f commit 1518b3b

File tree

13 files changed

+21
-21
lines changed

13 files changed

+21
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ body:
1313
and to help the community to collaborate in troubleshooting and fixing them.
1414
1515
Before you post, be sure to read our Contribution guidelines:
16-
https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines
16+
https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines
1717
1818
- type: textarea
1919
attributes:

.github/ISSUE_TEMPLATE/other.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
attributes:
1010
value: |
1111
Before you post, be sure to read our Contribution guidelines:
12-
https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines
12+
https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines
1313
1414
- type: textarea
1515
attributes:

.github/ISSUE_TEMPLATE/question.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ body:
99
attributes:
1010
value: |
1111
Before you post, be sure to read our Contribution guidelines:
12-
https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines
12+
https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines
1313
1414
- type: textarea
1515
attributes:

.github/ISSUE_TEMPLATE/rfc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ body:
1010
attributes:
1111
value: |
1212
Before you post, be sure to read our Contribution guidelines:
13-
https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines
13+
https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines
1414
1515
- type: textarea
1616
attributes:

.github/PULL-REQUEST-TEMPLATE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!--
22
Before you open a PR, be sure to read our Contribution guidelines:
3-
https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines
3+
https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines
44
-->
55

66
## About the Contributor
@@ -79,4 +79,4 @@ If they're not, please open the PR as a Draft.
7979
- [ ] PR is ready to be reviewed.
8080
- [ ] The functionality has been tested by the author.
8181
- [ ] Relevant unit tests has been added / updated.
82-
- [ ] Relevant documentation (code comments, [system documentation](https://sofie-automation.github.io/sofie-core//)) has been added / updated.
82+
- [ ] Relevant documentation (code comments, [system documentation](https://sofie-automation.github.io/sofie-core/)) has been added / updated.

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
- [Changelog for _Sofie Core_](meteor/CHANGELOG.md)
2-
- [_Sofie_ Releases](https://sofie-automation.github.io/sofie-core//releases)
2+
- [_Sofie_ Releases](https://sofie-automation.github.io/sofie-core/releases)

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# How to Contribute to this Repository
22

3-
Before contributing to this specific repository, please read the [Contribution Guidelines](https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines) for the Sofie project.
3+
Before contributing to this specific repository, please read the [Contribution Guidelines](https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines) for the Sofie project.
44

55
## Branches
66

77
This repository uses the following branches:
88

9-
- **_master_** is our main branch. We consider it stable and it is used in production.
9+
- **_main_** is our main branch. We consider it stable and it is used in production.
1010
- The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch.
1111

1212
We require contributions to be based based on the latest **_release\*_** branch.
13-
The [_Sofie Releases_](https://sofie-automation.github.io/sofie-core//releases) page collects the status and timeline of the releases.
13+
The [_Sofie Releases_](https://sofie-automation.github.io/sofie-core/releases) page collects the status and timeline of the releases.

DEVELOPER.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ Before you start, be sure to read the [Contribution guidelines](CONTRIBUTING.md)
66

77
### Documentation
88

9-
The documentation can be found at [Sofie TV Automation Documentation](https://sofie-automation.github.io/sofie-core//) and its for subsection [For Developers](https://sofie-automation.github.io/sofie-core//docs/for-developers/intro). Specific _Sofie Core_ information can also be in `DOCS.md` and `DEVELOPER.md` in the subfolders of this git project, for example [meteor/server/api/playout](meteor/server/api/playout/DOCS.md).
9+
The documentation can be found at [Sofie TV Automation Documentation](https://sofie-automation.github.io/sofie-core/) and its for subsection [For Developers](https://sofie-automation.github.io/sofie-core/docs/for-developers/intro). Specific _Sofie Core_ information can also be in `DOCS.md` and `DEVELOPER.md` in the subfolders of this git project, for example [meteor/server/api/playout](meteor/server/api/playout/DOCS.md).
1010

1111
### Monorepo Layout
1212

13-
This repository is a monorepo and contains both the main application (usually called server-core) as well as multiple auxiliary projects. In the `meteor` folder you will find the main Meteor application with `server` and `client` sub folders for the server-side application and front end. The `packages` folder contains other libraries and apps used together with Sofie Core.
13+
This repository is a monorepo and contains both the main application (usually called server-core) as well as multiple auxiliary projects. In the `meteor` folder you will find the main Meteor application with `server` for the server-side application. The `packages` folder contains the frontend, other libraries and apps used together with Sofie Core.
1414

1515
## Getting Started with Local Development
1616

17-
Follow these instructions to start up Sofie Core in development mode. (For production deploys, see [System documentation](https://sofie-automation.github.io/sofie-core//docs/user-guide/installation/intro).)
17+
Follow these instructions to start up Sofie Core in development mode. (For production deploys, see [System documentation](https://sofie-automation.github.io/sofie-core/docs/user-guide/installation/intro).)
1818

1919
### Prerequisites
2020

21-
- Install [Node.js](https://nodejs.org) 20 (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
22-
- Install [Meteor](https://www.meteor.com/install) (`npm install --global meteor`)
21+
- Install [Node.js](https://nodejs.org) 22 (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
22+
- Install [Meteor](https://www.meteor.com/install) (`npx meteor`)
2323
- Enable [corepack](https://nodejs.org/api/corepack.html#corepack) (`corepack enable`) as administrator/root. If `corepack` is not found, you may need to install it first with `npm install --global corepack`
2424

2525
- If on Windows, you may need to `npm install --global windows-build-tools` but this is not always necessary
@@ -72,7 +72,7 @@ The Sofie ui (served by Vite) can be accessed at `http://localhost:3005`. The me
7272

7373
### Lowering memory, CPU footprint in development
7474

75-
If you find yourself in a situation where running Sofie in development mode is too heavy, but you're not planning on modifying any of the low-level packages in the `packages` directory, you may want to run Sofie in the _UI-only mode_, in which only meteor will be rebuilt and type-checked on modification:
75+
If you find yourself in a situation where running Sofie in development mode is too heavy, but you're not planning on modifying any of the low-level packages in the `packages` directory, you may want to run Sofie in the _UI-only mode_, in which only meteor and the ui will be rebuilt and type-checked on modification:
7676

7777
```bash
7878
yarn dev --ui-only

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The _Core_ is a _Meteor/Node.JS_-based web server that serves the web GUIs as we
99
## General Sofie System Information
1010

1111
- [_Sofie_ Documentation](https://sofie-automation.github.io/sofie-core/)
12-
- [_Sofie_ Releases](https://sofie-automation.github.io/sofie-core//releases)
12+
- [_Sofie_ Releases](https://sofie-automation.github.io/sofie-core/releases)
1313
- [Contribution Guidelines](CONTRIBUTING.md)
1414
- [License](LICENSE)
1515

packages/documentation/docs/for-developers/for-blueprint-developers/manipulating-ingest-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Manipulating Ingest Data
22

3-
In Sofie we receive the rundown from an NRCS in the form of the `IngestRundown`, `IngestSegment` and `IngestPart` types. ([Source Code](https://github.com/nrkno/sofie-core/blob/master/packages/shared-lib/src/peripheralDevice/ingest.ts))
3+
In Sofie we receive the rundown from an NRCS in the form of the `IngestRundown`, `IngestSegment` and `IngestPart` types. ([Source Code](https://github.com/Sofie-Automation/sofie-core/blob/master/packages/shared-lib/src/peripheralDevice/ingest.ts))
44
These are passed into the `getRundown` or `getSegment` blueprints methods to transform them into a Rundown that Sofie can display and play.
55

66
At times it can be useful to manipulate this data before it gets passed into these methods. This wants to be done before `getSegment` in order to limit the scope of the re-generation needed. We could have made it so that `getSegment` is able to view the whole `IngestRundown`, but that would mean that any change to the `IngestRundown` would require re-generating every segment. This would be costly and could have side effects.

0 commit comments

Comments
 (0)