docs: prepare docs for Docusaurus v3 (#3139)
### Description V3 has several breaking changes that need to be addressed ### Testing Notes **What I did:** Tested using docusaurus: ```shell make docs-dev ```
This commit is contained in:
Kyle Robbertze
GitHub
parent
1b86b8eec5
commit
811f1eb833
@ -3,10 +3,10 @@ title: Install using docker
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import vars from '@site/vars';
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import CodeBlock from "@theme/CodeBlock";
|
||||
import vars from "@site/vars";
|
||||
|
||||
This guide walk you though the steps required to install LibreTime on your system using docker.
|
||||
|
||||
@ -19,7 +19,7 @@ Before installing LibreTime, you need to make sure that [Docker](https://docs.do
|
||||
First, set the version you want to install:
|
||||
|
||||
<CodeBlock language="bash">
|
||||
echo LIBRETIME_VERSION="{vars.version}" > .env
|
||||
echo LIBRETIME_VERSION="{vars.version}" > .env
|
||||
</CodeBlock>
|
||||
|
||||
Download the docker compose files from the repository:
|
||||
@ -3,10 +3,10 @@ title: Install using the installer
|
||||
sidebar_position: 20
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
import CodeBlock from '@theme/CodeBlock';
|
||||
import vars from '@site/vars';
|
||||
import Tabs from "@theme/Tabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import CodeBlock from "@theme/CodeBlock";
|
||||
import vars from "@site/vars";
|
||||
|
||||
This guide walk you though the steps required to install LibreTime on your system using the installer.
|
||||
|
||||
@ -69,13 +69,14 @@ Download the [latest released](https://github.com/libretime/libretime/releases)
|
||||
Or directly from the command-line:
|
||||
|
||||
<CodeBlock language="bash">
|
||||
wget https://github.com/libretime/libretime/releases/download/{vars.version}/libretime-{vars.version}.tar.gz
|
||||
wget https://github.com/libretime/libretime/releases/download/{vars.version}
|
||||
/libretime-{vars.version}.tar.gz
|
||||
</CodeBlock>
|
||||
|
||||
And extract the tarball:
|
||||
|
||||
<CodeBlock language="bash">
|
||||
tar -xvf libretime-{vars.version}.tar.gz && cd libretime
|
||||
tar -xvf libretime-{vars.version}.tar.gz && cd libretime
|
||||
</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
@ -108,9 +109,7 @@ git pull
|
||||
|
||||
And checkout the latest version:
|
||||
|
||||
<CodeBlock language="bash">
|
||||
git checkout {vars.version}
|
||||
</CodeBlock>
|
||||
<CodeBlock language="bash">git checkout {vars.version}</CodeBlock>
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2017-03-15" version="3.0.0-alpha"/>
|
||||
<ReleaseHead date="2017-03-15" version="3.0.0-alpha" />
|
||||
|
||||
The first release from the LibreTime Community.
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 1
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2017-04-20" version="3.0.0-alpha.1"/>
|
||||
<ReleaseHead date="2017-04-20" version="3.0.0-alpha.1" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 2
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2017-07-11" version="3.0.0-alpha.2"/>
|
||||
<ReleaseHead date="2017-07-11" version="3.0.0-alpha.2" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 3
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2017-10-18" version="3.0.0-alpha.3"/>
|
||||
<ReleaseHead date="2017-10-18" version="3.0.0-alpha.3" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 4
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2018-02-01" version="3.0.0-alpha.4"/>
|
||||
<ReleaseHead date="2018-02-01" version="3.0.0-alpha.4" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 5
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2018-10-12" version="3.0.0-alpha.5"/>
|
||||
<ReleaseHead date="2018-10-12" version="3.0.0-alpha.5" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 6
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2018-12-23" version="3.0.0-alpha.6"/>
|
||||
<ReleaseHead date="2018-12-23" version="3.0.0-alpha.6" />
|
||||
|
||||
## :rocket: Features
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 7
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2019-04-22" version="3.0.0-alpha.7"/>
|
||||
<ReleaseHead date="2019-04-22" version="3.0.0-alpha.7" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 8
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2019-08-02" version="3.0.0-alpha.8"/>
|
||||
<ReleaseHead date="2019-08-02" version="3.0.0-alpha.8" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 9
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2021-01-05" version="3.0.0-alpha.9"/>
|
||||
<ReleaseHead date="2021-01-05" version="3.0.0-alpha.9" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 10
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date="2021-10-15" version="3.0.0-alpha.10"/>
|
||||
<ReleaseHead date="2021-10-15" version="3.0.0-alpha.10" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 11
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-03-28' version='3.0.0-alpha.11'/>
|
||||
<ReleaseHead date="2022-03-28" version="3.0.0-alpha.11" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 12
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-03-29' version='3.0.0-alpha.12'/>
|
||||
<ReleaseHead date="2022-03-29" version="3.0.0-alpha.12" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -20,4 +20,4 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
||||
|
||||
## :memo: Colophon
|
||||
|
||||
This release mainly fixes bugs present in the [3.0.0-alpha.11 release](./3.0.0-alpha.11.md).
|
||||
This release mainly fixes bugs present in the [3.0.0-alpha.11 release](./3.0.0-alpha.11.mdx).
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 alpha 13
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-07-15' version='3.0.0-alpha.13'/>
|
||||
<ReleaseHead date="2022-07-15" version="3.0.0-alpha.13" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 beta 0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-09-16' version='3.0.0-beta.0'/>
|
||||
<ReleaseHead date="2022-09-16" version="3.0.0-beta.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -99,7 +99,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
||||
- **legacy:** track_type_id should cast to int not text ([#2112](https://github.com/libretime/libretime/issues/2112))
|
||||
- **worker:** rewrite podcast download task
|
||||
- **shared:** load env from oneOf union schema
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.11.1
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.11.1
|
||||
- nginx depends on legacy in docker-compose ([#2147](https://github.com/libretime/libretime/issues/2147))
|
||||
- **playout:** remove shutdown_handler
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 beta 1
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-09-23' version='3.0.0-beta.1'/>
|
||||
<ReleaseHead date="2022-09-23" version="3.0.0-beta.1" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0 beta 2
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-10-03' version='3.0.0-beta.2'/>
|
||||
<ReleaseHead date="2022-10-03" version="3.0.0-beta.2" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-10-10' version='3.0.0'/>
|
||||
<ReleaseHead date="2022-10-10" version="3.0.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.1
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2022-12-20' version='3.0.1'/>
|
||||
<ReleaseHead date="2022-12-20" version="3.0.1" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.0.2
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2023-02-21' version='3.0.2'/>
|
||||
<ReleaseHead date="2023-02-21" version="3.0.2" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.1.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2023-05-26' version='3.1.0'/>
|
||||
<ReleaseHead date="2023-05-26" version="3.1.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -63,20 +63,20 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
||||
- **playout:** remove outdated liquidsoap code
|
||||
- **playout:** add types
|
||||
- **api:** allow single digit version for legacy schema
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.12.1
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.12.1
|
||||
- remove systemd ProtectHome feature ([#2243](https://github.com/libretime/libretime/issues/2243))
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.13.1 ([#2249](https://github.com/libretime/libretime/issues/2249))
|
||||
- **worker:** replace deprecated cgi.parse_header
|
||||
- **installer:** install missing sudo
|
||||
- **installer:** set home and login when running as postgres
|
||||
- **legacy:** add log entry on task run ([#2316](https://github.com/libretime/libretime/issues/2316))
|
||||
- **legacy:** log errors on connect check failure ([#2317](https://github.com/libretime/libretime/issues/2317))
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.2
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.13.3
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.13.2
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.13.3
|
||||
- **legacy:** advanced search by track type id
|
||||
- **legacy:** move forked deps to the libretime namespace
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.4
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.14.5
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.14.4
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.14.5
|
||||
- **legacy:** ensure options is a dict during json encoding
|
||||
- **legacy:** don't use dict assignment on object ([#2384](https://github.com/libretime/libretime/issues/2384))
|
||||
- **playout:** quote escape strings in liquidsoap entrypoint
|
||||
@ -94,19 +94,19 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
||||
- **playout:** prevent unbound variables
|
||||
- **playout:** use int for liquidsoap queues map
|
||||
- **shared:** return type confusion
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.15.2
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.15.2
|
||||
- **api:** explicit FileImportStatusEnum in schema
|
||||
- pin postgresql version in docker-compose
|
||||
- pin rabbitmq version in docker-compose
|
||||
- allow overriding docker-compose predefined environment
|
||||
- move docker specific setup to dockerfile
|
||||
- **api:** cast string value to int enum ([#2461](https://github.com/libretime/libretime/issues/2461))
|
||||
- **playout:** quote incompatible <py3.9 type hints
|
||||
- **playout:** quote incompatible \<py3.9 type hints
|
||||
- **installer:** bump setuptools to ~=67.3 ([#2387](https://github.com/libretime/libretime/issues/2387))
|
||||
- **playout:** use new api-client v1
|
||||
- **playout:** catch oserror in liquidsoap client
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
|
||||
- **api:** require django >=4.2.0,<4.3
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.16.1 (main) ([#2490](https://github.com/libretime/libretime/issues/2490))
|
||||
- **api:** require django >=4.2.0,\<4.3
|
||||
- **api:** upgrade psycopg to v3.1
|
||||
- **playout:** remove unused ecasound package ([#2496](https://github.com/libretime/libretime/issues/2496))
|
||||
- **installer:** ignore whitespace during diff
|
||||
@ -115,7 +115,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
||||
- **legacy:** keep datatable settings between views ([#2519](https://github.com/libretime/libretime/issues/2519))
|
||||
- **api:** upgrade django code (pre-commit)
|
||||
- **analyzer:** remove unused python3 package
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to <3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
|
||||
- **deps:** update dependency friendsofphp/php-cs-fixer to \<3.17.1 (main) ([#2556](https://github.com/libretime/libretime/issues/2556))
|
||||
|
||||
## :arrow_up: Upgrading
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 3.2.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2023-10-15' version='3.2.0'/>
|
||||
<ReleaseHead date="2023-10-15" version="3.2.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 4.0.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2024-01-07' version='4.0.0'/>
|
||||
<ReleaseHead date="2024-01-07" version="4.0.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 4.1.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2024-05-05' version='4.1.0'/>
|
||||
<ReleaseHead date="2024-05-05" version="4.1.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 4.2.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<ReleaseHead date='2024-06-22' version='4.2.0'/>
|
||||
<ReleaseHead date="2024-06-22" version="4.2.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -2,9 +2,9 @@
|
||||
title: LibreTime 4.3.0
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<!-- <ReleaseHead date='2025-03-13' version='4.3.0/> -->
|
||||
<ReleaseHead date="2025-03-13" version="4.3.0" />
|
||||
|
||||
## :sparkling_heart: Contributors
|
||||
|
||||
@ -1,6 +1,8 @@
|
||||
import TarballLink from '@site/src/components/TarballLink';
|
||||
import TarballLink from "@site/src/components/TarballLink";
|
||||
|
||||
<p>This version was released the <strong>{props.date}</strong>.</p>
|
||||
<p>
|
||||
This version was released on <strong>{props.date}</strong>.
|
||||
</p>
|
||||
|
||||
:::info
|
||||
|
||||
@ -11,6 +13,6 @@ For general discussion or if you need help, you can join the [discourse](https:/
|
||||
:::
|
||||
|
||||
<p>
|
||||
The full tarball for the <code>{props.version}</code> release of
|
||||
LibreTime is available <TarballLink version={props.version}>here</TarballLink>.
|
||||
The full tarball for the <code>{props.version}</code> release of LibreTime is
|
||||
available <TarballLink version={props.version}>here</TarballLink>.
|
||||
</p>
|
||||
@ -2,7 +2,7 @@
|
||||
title: Unreleased
|
||||
---
|
||||
|
||||
import ReleaseHead from './\_release-head.md';
|
||||
import ReleaseHead from "./_release-head.mdx";
|
||||
|
||||
<!-- <ReleaseHead date='2022-01-01' version='3.0.0-alpha.11'/> -->
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user