docs: fix vale linting errors
- are not > aren't - auto-_ > auto _ - avoid backend - cannot > can't - do not > don't - does not > doesn't - ignore emoji code - has not > hasn't - ignore Microsoft.GeneralURL - is not > isn't - it is > it's - no exclamation point - put code inside code blocks - put commit sha inside code blocks - put exception message in code blocks - remove slang - should not > shouldn't - they are > they're - we are > we're - will not > won't
This commit is contained in:
parent
722a683896
commit
50809a933c
42 changed files with 174 additions and 160 deletions
|
@ -67,13 +67,13 @@ The LibreTime architecture is split into 2 main monolithic blocks `Create the sc
|
|||
|
||||
:::note
|
||||
|
||||
A microservice architecture was rejected as it will not fix or improve any aspect of LibreTime.
|
||||
A microservice architecture was rejected as it won't fix or improve any aspect of LibreTime.
|
||||
|
||||
:::
|
||||
|
||||
:::warning
|
||||
|
||||
This document tries to focus on creating and playing a schedule, it does not consider features such as monitoring, logging or archiving.
|
||||
This document tries to focus on creating and playing a schedule, it doesn't consider features such as monitoring, logging or archiving.
|
||||
|
||||
:::
|
||||
|
||||
|
@ -90,7 +90,7 @@ The web API, the worker and the message API rely on the [Django framework](https
|
|||
|
||||
### Play the schedule
|
||||
|
||||
Since the `Play the schedule` has its own requirements in terms of logic and uptime, it is handled separately from the `Create the schedule` block. This block needs to be able to be duplicated in a high availability context.
|
||||
Since the `Play the schedule` has its own requirements in terms of logic and uptime, it's handled separately from the `Create the schedule` block. This block needs to be able to be duplicated in a high availability context.
|
||||
|
||||
This block contains the following components:
|
||||
|
||||
|
@ -101,7 +101,7 @@ This block contains the following components:
|
|||
|
||||
### One setup per radio station
|
||||
|
||||
LibreTime is not meant to be used in a multi-tenant architecture, and an entire LibreTime installation should be dedicated to a single radio station. Previous SAAS or multi-tenant features from Airtime should be deprecated or removed.
|
||||
LibreTime isn't meant to be used in a multi-tenant architecture, and an entire LibreTime installation should be dedicated to a single radio station. Previous SAAS or multi-tenant features from Airtime should be deprecated or removed.
|
||||
|
||||
### Separation of concerns
|
||||
|
||||
|
|
|
@ -8,7 +8,7 @@ Since LibreTime forked, the `schema_version` in the `schema.sql` was locked on `
|
|||
|
||||
:::
|
||||
|
||||
Django does not maintain a `schema.sql` file, it applies every migrations until it reaches the targeted schema represented by the code. The legacy `schema_version` has to be tracked until we remove the Propel schema generation and let Django handle all the schema migrations. Until then Propel generate the schema and Django handle migrations from already installed databases.
|
||||
Django doesn't maintain a `schema.sql` file, it applies every migrations until it reaches the targeted schema represented by the code. The legacy `schema_version` has to be tracked until we remove the Propel schema generation and let Django handle all the schema migrations. Until then Propel generate the schema and Django handle migrations from already installed databases.
|
||||
|
||||
:::info
|
||||
|
||||
|
|
|
@ -32,7 +32,7 @@ This guide walks you through the steps required to release a new version of Libr
|
|||
|
||||
:::caution
|
||||
|
||||
This guide is still a work in progress, and does not cover every use cases. Depending on
|
||||
This guide is still a work in progress, and doesn't cover every use cases. Depending on
|
||||
the version bump, some steps might be wrong. For example, in case of a patch release,
|
||||
the documentation requires different changes.
|
||||
|
||||
|
@ -133,7 +133,7 @@ Squash the changes and open a pull request for others to review:
|
|||
git rebase --autosquash --interactive main
|
||||
```
|
||||
|
||||
Merge the pull request when it is reviewed and ready.
|
||||
Merge the pull request when it's reviewed and ready.
|
||||
|
||||
### 5. Create and push a tag
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@ We're in the process of rewriting LibreTime's API. This page contains the instru
|
|||
|
||||
The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter _Exporting the schedule_), all API requests must be authenticated using the secret API key stored in the file `/etc/libretime/api_client.cfg` on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server.
|
||||
|
||||
If you intend to use the LibreTime API across a public network, for security reasons it is highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
|
||||
If you intend to use the LibreTime API across a public network, for security reasons it's highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
|
||||
|
||||
The format of API requests is:
|
||||
|
||||
|
@ -23,7 +23,7 @@ where api-action is the type of request and XXXXXX is the secret API key. Availa
|
|||
- on-air-light - return true if the station is on air
|
||||
- status - get the status of LibreTime components and resource usage
|
||||
- version - returns the version of LibreTime installed
|
||||
- get-files-without-silan-value - list files for which silence detection has not yet been performed
|
||||
- get-files-without-silan-value - list files for which silence detection hasn't yet been performed
|
||||
- get-stream-setting - gets the settings of LibreTime output streams
|
||||
- get-stream-parameters - gets the parameters of LibreTime output streams
|
||||
|
||||
|
@ -50,7 +50,7 @@ which is enough information to construct a player widget dynamically. (s1_url is
|
|||
Some API requests require the directory ID number to be specified as _dir_id_ including:
|
||||
|
||||
- list-all-files - list files in the specified directory
|
||||
- get-files-without-replay-gain - list files in the specified directory for which ReplayGain has not been calculated yet
|
||||
- get-files-without-replay-gain - list files in the specified directory for which ReplayGain hasn't been calculated yet
|
||||
|
||||
For example, using a request such as:
|
||||
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
title: Widgets
|
||||
---
|
||||
|
||||
Bring your LibreTime broadcast to your website with embeddable widgets! LibreTime comes with two widgets: a streaming player and a schedule. Both widgets use iframes to display and can be placed wherever embeddable code can on a website.
|
||||
Bring your LibreTime broadcast to your website with embeddable widgets. LibreTime comes with two widgets: a streaming player and a schedule. Both widgets use iframes to display and can be placed wherever embeddable code can on a website.
|
||||
|
||||
## Getting started
|
||||
|
||||
|
@ -12,7 +12,7 @@ Before using the widgets, make sure LibreTime's Public API is enabled in **Setti
|
|||
|
||||
:::tip Note
|
||||
|
||||
LibreTime widgets cannot function through VPNs or SSH tunneling. The instance must be accessible from the internet for the widgets to work.
|
||||
LibreTime widgets can't function through VPNs or SSH tunneling. The instance must be accessible from the internet for the widgets to work.
|
||||
|
||||
:::
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue