Skip to content

Commit b76691a

Browse files
committed
chore(docs): word capitalization
1 parent e1c5105 commit b76691a

File tree

8 files changed

+18
-18
lines changed

8 files changed

+18
-18
lines changed

packages/documentation/docs/for-developers/data-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In every case, any layout changes and any scheduled cleanup are performed by the
1818

1919
This category of collections is rather loosely defined, as it ends up being everything that doesn't belong somewhere else
2020

21-
This consists of anything that is configurable from the Sofie UI, anything needed soley for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by package manager, through an API over DDP.
21+
This consists of anything that is configurable from the Sofie UI, anything needed soley for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by Package Manager, through an API over DDP.
2222
Currently, there is not a very clearly defined flow for modifying these documents, with the UI often making changes directly with minimal or no validation.
2323

2424
This includes:
@@ -76,7 +76,7 @@ The collections which are owned by the ingest workers are:
7676
- [Segments](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Segments.ts)
7777

7878
These collections model a Rundown from the NRCS in a Sofie form. Almost all of these contain documents which are largely generated by blueprints.
79-
Some of these collections are used by package manager to initiate work, while others form a view of the Rundown for the users, and are used as part of the model for playout.
79+
Some of these collections are used by Package Manager to initiate work, while others form a view of the Rundown for the users, and are used as part of the model for playout.
8080

8181
### Playout
8282

packages/documentation/docs/for-developers/json-config-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Names of the enum values as generated for the typescript enum, which we display
5555

5656
Note: Only valid for blueprint configuration.
5757

58-
Sometimes it can be useful to reference other values. This property can be used on string fields, to let sofie generate a dropdown populated with values valid in the current context.
58+
Sometimes it can be useful to reference other values. This property can be used on string fields, to let Sofie generate a dropdown populated with values valid in the current context.
5959

6060
#### `mappings`
6161

packages/documentation/docs/for-developers/publications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There has been a recent push towards using more 'custom' publications for stream
3232
To achieve this, we have an `optimisedObserver` flow which is designed to help maange to a custom publication, with a few methods to fill in to setup the reactivity and the data transformation.
3333

3434
One such publication is the `PieceContentStatus`, prior to version 1.50, this was computed inside the UI.
35-
A brief overview of this publication, is that it looks at each Piece in a Rundown, and reports whether the Piece is 'OK'. This check is primarily focussed on Pieces containing clips, where it will check the metadata generated by either package manager or media manager to ensure that the clip is marked as being ready for playout, and that it has the correct format and some other quality checks.
35+
A brief overview of this publication, is that it looks at each Piece in a Rundown, and reports whether the Piece is 'OK'. This check is primarily focussed on Pieces containing clips, where it will check the metadata generated by Package Manager to ensure that the clip is marked as being ready for playout, and that it has the correct format and some other quality checks.
3636

3737
To do this on the client meant needing to subscribe to the whole contents of a couple of MongoDB collections, as it is not easy to determine which documents will be needed until the check is being run. This caused some issues as these collections could get rather large. We also did not always have every Piece loaded in the UI, so had to defer some of the computation to the backend via polling.
3838

packages/documentation/docs/user-guide/features/access-levels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 3
77
## Permissions
88

99
There are a few different access levels that users can be assigned. They are not heirarchical, you will often need to enable multiple for each user.
10-
Any client that can access sofie always has at least view-only access to the rundowns, and system status pages.
10+
Any client that can access Sofie always has at least view-only access to the rundowns, and system status pages.
1111

1212
| Level | Summary |
1313
| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- |

packages/documentation/docs/user-guide/installation/installing-package-manager.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ Although Package Manager can be used to copy any kind of file to/from a wide arr
1818

1919
:::caution
2020

21-
Sofie supports only one package manager running for a Studio. Attaching more at a time will result in weird behaviour due to them fighting over reporting the statuses of packages.
22-
If you feel like you need multiple, then you likely want to run package manager in the distributed setup instead.
21+
Sofie supports only one Package Manager running for a Studio. Attaching more at a time will result in weird behaviour due to them fighting over reporting the statuses of packages.
22+
If you feel like you need multiple, then you likely want to run Package Manager in the distributed setup instead.
2323

2424
:::
2525

2626
:::caution
2727

28-
The package manager worker process is primarily tested on Windows only. It does run on Linux (without support for network shares), but has not been extensively tested.
28+
The Package Manager worker process is primarily tested on Windows only. It does run on Linux (without support for network shares), but has not been extensively tested.
2929

3030
:::
3131

@@ -58,7 +58,7 @@ This first run is necessary to get the Package Manager device registered with _S
5858

5959
## Installation In Production
6060

61-
Only one package manager can be running for a Sofie Studio. If you reached this point thinking of deploying multiple, you will want to follow the distributed setup.
61+
Only one Package Manager can be running for a Sofie Studio. If you reached this point thinking of deploying multiple, you will want to follow the distributed setup.
6262

6363
### Simple Setup
6464

@@ -78,7 +78,7 @@ When configuring the http proxy server in Sofie, you may need to follow extra co
7878

7979
### Distributed Setup
8080

81-
For setups where you need to interact with multiple CasparCG machines, or want a more resilient/scalable setup, package manager can be partially deployed in Docker, with just the workers running on each CasparCG machine.
81+
For setups where you need to interact with multiple CasparCG machines, or want a more resilient/scalable setup, Package Manager can be partially deployed in Docker, with just the workers running on each CasparCG machine.
8282

8383
An example `docker-compose` of the setup is as follows:
8484

@@ -110,7 +110,7 @@ services:
110110
context: .
111111
dockerfile: sofietv/package-manager-package-manager
112112
environment:
113-
CORE_HOST: '172.18.0.1' # the address for connecting back to sofie core from this image
113+
CORE_HOST: '172.18.0.1' # the address for connecting back to Sofie core from this image
114114
CORE_PORT: '3000'
115115
DEVICE_ID: 'my-package-manager-id'
116116
DEVICE_TOKEN: 'some-secret'
@@ -133,7 +133,7 @@ In addition to this, you will need to run the appContainer and workers on each w
133133
./appContainer-node.exe
134134
--appContainerId=caspar01 // This is a unique id for this instance of the appContainer
135135
--workforceURL=ws://workforce-service-ip:8070
136-
--resourceId=caspar01 // This should also be set in the 'resource id' field of the `casparcgLocalFolder1` accessor. This is how package manager can identify which machine is which.
136+
--resourceId=caspar01 // This should also be set in the 'resource id' field of the `casparcgLocalFolder1` accessor. This is how Package Manager can identify which machine is which.
137137
--networkIds=pm-net // This is not necessary, but can be useful for more complex setups
138138
```
139139

@@ -144,7 +144,7 @@ Note that each appContainer needs to use a different resourceId and will need it
144144
## Configuration
145145

146146
1. Open the _Sofie Core_ Settings page ([http://localhost:3000/settings?admin=1](http://localhost:3000/settings?admin=1)), click on your Studio, and then Peripheral Devices.
147-
1. Click the plus button (`+`) in the Parent Devices section and configure the created device to be for your Package manager.
147+
1. Click the plus button (`+`) in the Parent Devices section and configure the created device to be for your Package Manager.
148148
1. On the sidebar under the current Studio, select to the Package Manager section.
149149
1. Click the plus button under the Package Containers heading, then click the edit icon (pencil) to the right of the newly-created package container.
150150
1. Give this package container an ID of `casparcgContainer0` and a label of `CasparCG Package Container`.
@@ -167,7 +167,7 @@ By adding `--networkIds=pm-net` (a semi colon separated list) when launching the
167167

168168
Then in the Sofie UI:
169169

170-
1. Return to the Package manager settings under the studio
170+
1. Return to the Package Manager settings under the studio
171171
1. Expand the `casparcgContainer` container.
172172
1. Edit the `casparcgHttpProxy` accessor to have a `Base URL` that is accessible from the casparcg machines.
173173
1. Set the `Network ID` to `pm-net` (matching what was passed in the command line)

packages/documentation/versioned_docs/version-1.50.0/for-developers/data-model.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ In every case, any layout changes and any scheduled cleanup are performed by the
1818

1919
This category of collections is rather loosely defined, as it ends up being everything that doesn't belong somewhere else
2020

21-
This consists of anything that is configurable from the Sofie UI, anything needed soley for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by package manager, through an API over DDP.
21+
This consists of anything that is configurable from the Sofie UI, anything needed soley for the UI and some other bits. Additionally, there are some collections which are populated by other portions of a Sofie system, such as by Package Manager, through an API over DDP.
2222
Currently, there is not a very clearly defined flow for modifying these documents, with the UI often making changes directly with minimal or no validation.
2323

2424
This includes:
@@ -76,7 +76,7 @@ The collections which are owned by the ingest workers are:
7676
- [Segments](https://github.com/nrkno/sofie-core/blob/master/packages/corelib/src/dataModel/Segments.ts)
7777

7878
These collections model a Rundown from the NRCS in a Sofie form. Almost all of these contain documents which are largely generated by blueprints.
79-
Some of these collections are used by package manager to initiate work, while others form a view of the Rundown for the users, and are used as part of the model for playout.
79+
Some of these collections are used by Package Manager to initiate work, while others form a view of the Rundown for the users, and are used as part of the model for playout.
8080

8181
### Playout
8282

packages/documentation/versioned_docs/version-1.50.0/for-developers/json-config-schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Names of the enum values as generated for the typescript enum, which we display
5555

5656
Note: Only valid for blueprint configuration.
5757

58-
Sometimes it can be useful to reference other values. This property can be used on string fields, to let sofie generate a dropdown populated with values valid in the current context.
58+
Sometimes it can be useful to reference other values. This property can be used on string fields, to let Sofie generate a dropdown populated with values valid in the current context.
5959

6060
#### `mappings`
6161

packages/documentation/versioned_docs/version-1.50.0/for-developers/publications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There has been a recent push towards using more 'custom' publications for stream
3232
To achieve this, we have an `optimisedObserver` flow which is designed to help maange to a custom publication, with a few methods to fill in to setup the reactivity and the data transformation.
3333

3434
One such publication is the `PieceContentStatus`, prior to version 1.50, this was computed inside the UI.
35-
A brief overview of this publication, is that it looks at each Piece in a Rundown, and reports whether the Piece is 'OK'. This check is primarily focussed on Pieces containing clips, where it will check the metadata generated by either package manager or media manager to ensure that the clip is marked as being ready for playout, and that it has the correct format and some other quality checks.
35+
A brief overview of this publication, is that it looks at each Piece in a Rundown, and reports whether the Piece is 'OK'. This check is primarily focussed on Pieces containing clips, where it will check the metadata generated by either Package Manager or media manager to ensure that the clip is marked as being ready for playout, and that it has the correct format and some other quality checks.
3636

3737
To do this on the client meant needing to subscribe to the whole contents of a couple of MongoDB collections, as it is not easy to determine which documents will be needed until the check is being run. This caused some issues as these collections could get rather large. We also did not always have every Piece loaded in the UI, so had to defer some of the computation to the backend via polling.
3838

0 commit comments

Comments
 (0)