docs: split developer and contributor manual
This commit is contained in:
jo
Kyle Robbertze
parent
bb755f7a62
commit
a9b7513bc0
|
|
@ -46,7 +46,7 @@ LibreTime requires the following default ports to be open:
|
|||
|
||||
The installer is shipped in the released tarballs or directly in the project repository.
|
||||
|
||||
We recommend installing on one of the following [distribution releases](../../developer-manual/development/releases.md#distributions-releases-support):
|
||||
We recommend installing on one of the following [distribution releases](../../contributor-manual/releases.md#distributions-releases-support):
|
||||
|
||||
- [Debian 11](https://www.debian.org/releases/)
|
||||
- [Ubuntu 20.04 LTS](https://wiki.ubuntu.com/Releases)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
---
|
||||
title: Contributor manual
|
||||
---
|
||||
|
||||
Welcome to the **LibreTime contributor manual**, you should find guides to improve and contribute to LibreTime.
|
||||
|
||||
- Learn about the [architecture of LibreTime](./design/architecture.md)
|
||||
- Learn about the [database design](./design/database.md)
|
||||
|
||||
- Start coding by setting up a [development environment](./development-environment.md)
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
label: Contributor manual
|
||||
position: 50
|
||||
|
|
@ -1,4 +1,8 @@
|
|||
# Database schema creation and migrations
|
||||
---
|
||||
title: Database
|
||||
---
|
||||
|
||||
## Database schema creation and migrations
|
||||
|
||||
The method to maintain the database schema, is to write both a migration file for already installed databases and to update a `schema.sql` file for fresh databases. On fresh installation, the database is filled with the `schema.sql` and `data.sql` files and LibreTime won't run any sql migration on top of it. Previously, when LibreTime was upgraded, the missing migrations were run using a custom php based migration tool, those migrations are now handled by Django. The missing migrations are tracked using both a `schema_version` field in the `cc_pref` table and a Django migration id.
|
||||
|
||||
|
|
@ -130,7 +130,7 @@ multipass shell ltTEST
|
|||
```
|
||||
|
||||
Multipass isn't currently able to do an automated install from the cloud-init script.
|
||||
After you enter the shell for the first time, you will still need to [run the LibreTime installer](../../admin-manual/setup/install.md).
|
||||
After you enter the shell for the first time, you will still need to [run the LibreTime installer](../admin-manual/setup/install.md).
|
||||
|
||||
The IP address of your new VM can be found by running `multipass list`. Copy and paste it into your web browser to access the LibreTime interface and complete the setup wizard.
|
||||
|
||||
|
|
@ -2,13 +2,8 @@
|
|||
title: Developer manual
|
||||
---
|
||||
|
||||
Welcome to the **LibreTime developer manual**, you should find guides to integrate LibreTime and tools to improve and contribute to LibreTime.
|
||||
Welcome to the **LibreTime developer manual**, you should find guides to integrate LibreTime.
|
||||
|
||||
## Integrate LibreTime
|
||||
|
||||
- :construction: Work in progress
|
||||
|
||||
## Improve and contribute to LibreTime
|
||||
|
||||
- Learn about the [architecture of LibreTime](./design/architecture.md)
|
||||
- Learn about the [database migrations](./design/database-migrations.md)
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
label: Development
|
||||
|
|
@ -109,7 +109,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
|
|||
|
||||
### Ubuntu Bionic support deprecation
|
||||
|
||||
Support for Ubuntu Bionic is being deprecated, and will be removed in LibreTime v3.1.0. Maintenance only versions (3.0.x) for Ubuntu Bionic will be provided until the distribution release reaches its end of life. Please see the [supported distributions release policy](../developer-manual/development/releases.md#distributions-releases-support) for details.
|
||||
Support for Ubuntu Bionic is being deprecated, and will be removed in LibreTime v3.1.0. Maintenance only versions (3.0.x) for Ubuntu Bionic will be provided until the distribution release reaches its end of life. Please see the [supported distributions release policy](../contributor-manual/releases.md#distributions-releases-support) for details.
|
||||
|
||||
Along with the Ubuntu Bionic deprecation, the following dependencies versions are also being deprecated:
|
||||
|
||||
|
|
@ -119,7 +119,7 @@ Along with the Ubuntu Bionic deprecation, the following dependencies versions ar
|
|||
|
||||
### Debian Buster support deprecation
|
||||
|
||||
Support for Debian Buster is being deprecated, and will be removed in LibreTime v3.1.0. Maintenance only versions (3.0.x) for Debian Buster will be provided until the distribution release reaches its end of life. Please see the [supported distributions release policy](../developer-manual/development/releases.md#distributions-releases-support) for details.
|
||||
Support for Debian Buster is being deprecated, and will be removed in LibreTime v3.1.0. Maintenance only versions (3.0.x) for Debian Buster will be provided until the distribution release reaches its end of life. Please see the [supported distributions release policy](../contributor-manual/releases.md#distributions-releases-support) for details.
|
||||
|
||||
Along with the Debian Buster deprecation, the following dependencies versions are also being deprecated:
|
||||
|
||||
|
|
|
|||
|
|
@ -31,4 +31,4 @@ AAC streams aren't working out of the box because the [current distributions pac
|
|||
|
||||
### On Ubuntu Bionic, analyzing some FLAC files fails
|
||||
|
||||
[On Ubuntu Bionic, analyzing some FLAC files fails with `UnplayableFileError`](https://github.com/libretime/libretime/issues/2218) because of an upstream bug in Liquidsoap. If you encounter this, you should [upgrade to a more recent distribution version](../developer-manual/development/releases.md#distributions-releases-support).
|
||||
[On Ubuntu Bionic, analyzing some FLAC files fails with `UnplayableFileError`](https://github.com/libretime/libretime/issues/2218) because of an upstream bug in Liquidsoap. If you encounter this, you should [upgrade to a more recent distribution version](../contributor-manual/releases.md#distributions-releases-support).
|
||||
|
|
|
|||
Loading…
Reference in New Issue