LibreTime: Radio Broadcast & Automation Platform
Go to file
Jonas L 3ec85d7821
docs: update structure and create links between pages (#1611)
* docs: rework files structure

* rewrite documentation entrypoint

* update category files and use yml

* add manuals entry page

* update admin-manual titles and page order

* create releases sections

* move ssl configuration to reverse proxy

* docs: update website vars and links

* update release note codeblock syntax key

* resurect troubleshooting guide

* Update freeipa custom auth documentation

* add notice about the state of the documentation

* update the backup documentation

* tmp: allow to deploy the website for preview

* Don't use require.resolve for plugins

* Update the main page link dest

* update development environment title

* rewrite the install/upgrade/migrate as guides

* update website docs sections links

* Fix urls

* move release note to documentation

* move home links to vars files

* tmp: update deploy url

* add react to tsconfig to handle jsx linting

* fix: replace absolute url to relative path to files

* tmp: allow CI Website dpeloy on working branch

* Update release note title

* use default syntax highlighting theme

* update the troubleshooting guide

* Wording

* use CodeBlock components

* Better prose

* remove api_client config section

* fix prose errors

* update import prefix for vars file

* reroder docs manuals links

* use sentence capitalization for page titles

* Wording

* missing word

* Update note about syslog log file

* wording
2022-02-21 09:16:54 +02:00
.github docs: update structure and create links between pages (#1611) 2022-02-21 09:16:54 +02:00
analyzer fix(analyzer): update docstring for organise_file 2022-02-20 22:11:00 +02:00
api feat(api): improve uwsgi systemd integration (#1614) 2022-02-19 09:03:25 +02:00
api_client test(api_client): add bandit linter check 2022-02-14 21:01:35 +02:00
docs docs: update structure and create links between pages (#1611) 2022-02-21 09:16:54 +02:00
installer chore: add pyupgrade pre-commit hook 2022-01-27 10:37:48 +02:00
legacy style: fix php-cs-fixer linting (#1575) 2022-02-08 11:14:59 +02:00
playout test(playout): add bandit linter check 2022-02-14 21:01:35 +02:00
shared test(shared): config with required submodel (#1616) 2022-02-20 20:11:49 +00:00
tools chore: set default python target to install 2022-02-14 21:01:35 +02:00
website docs: update structure and create links between pages (#1611) 2022-02-21 09:16:54 +02:00
worker test(worker): add bandit linter check 2022-02-14 21:01:35 +02:00
.codespellignore chore: remove jekyll out-of-date codespell ignore (#1613) 2022-02-18 23:07:35 +02:00
.gitattributes Create .gitattributes to ensure proper cloning with Windows Git 2017-04-09 14:41:52 -04:00
.gitignore Move composer files in airtime_mvc 2021-09-11 04:48:53 +02:00
.pre-commit-config.yaml chore: update pre-commit to handle js/ts/css files 2022-02-10 08:17:02 +01:00
.vale.ini docs: update structure and create links between pages (#1611) 2022-02-21 09:16:54 +02:00
CONTRIBUTING.md docs: fix broken links 2022-02-10 08:40:38 +01:00
LEGACY.md Add Table of Content to LEGACY file 2021-09-02 20:55:16 +02:00
LICENSE Small update to LICENSE 2021-09-02 16:06:26 +02:00
Makefile ci: setup docs prose linting with vale 2022-02-11 10:12:07 +01:00
README.md chore: move and clean logo to website (#1590) 2022-02-11 12:20:45 +02:00
Vagrantfile chore: allow no port fowarding in vagrant (#1498) 2022-01-10 08:20:45 +02:00
cloud-init.yml Format code using prettier 2021-06-04 17:04:53 +02:00
install feat: remove unused ubuntu ppa (#1591) 2022-02-11 15:34:32 +02:00
packages.ini feat: debian 11 support (#1292) 2021-11-09 11:21:40 +02:00
uninstall chore: resolve shell warnings 2021-11-08 20:57:41 +01:00

README.md

Tests Financial Contributors on Open Collective

LibreTime makes it easy to run your own online or terrestrial radio station. It is a community managed fork of the AirTime project.

It is managed by a friendly inclusive community of stations from around the globe that use, document and improve LibreTime. Join us in fixing bugs and in defining how we manage the codebase going forward.

We are currently ramping up development on this repository.

Check out the documentation for more information and start broadcasting!

Please note that LibreTime is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Please submit enhancements, bugfixes or comments via GitHub.

Development Process

The LibreTime follows the standardized Collective Code Construction Contract (C4). Its abstract is provided here.

C4 provides a standard process for contributing, evaluating and discussing improvements on software projects. It defines specific technical requirements for projects like a style guide, unit tests, git and similar platforms. It also establishes different personas for projects, with clear and distinct duties. C4 specifies a process for documenting and discussing issues including seeking consensus and clear descriptions, use of "pull requests" and systematic reviews.

The full text of the contract is licensed under the GPL and available at the above link courtesy of the ZeroMQ community.

Releasing

The LibreTime maintainers release new versions of LibreTime at regular intervals. We follow the Semantic Versioning standards.

In a nutshell, given a version number MAJOR.MINOR.PATCH we increment the:

  1. MAJOR version when we make incompatible API changes,
  2. MINOR version when we add functionality in a backwards-compatible manner, and
  3. PATCH version when we make backwards-compatible bug fixes.

Given the history of the project we will be starting with version 3.0.0.

Stay tuned for early alphas and lots of betas as we get development up and running.

Support

To get support for any questions or problems you might have using the software we have a forum at discourse.libretime.org. We are moving towards using the forum to provide community support and reserving the github issue queue for confirmed bugs and well-formed feature requests.

You can also contact us through our Mattermost instance where you can talk with other users and developers.

Contributors

Code Contributors

This project exists thanks to all the people who contribute.

Financial Contributors

Become a financial contributor and help us sustain our community on OpenCollective.

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website.

License

LibreTime is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, version 3 of the License.

Copyright (c) 2011-2017 Sourcefabric z.ú.

Copyright (c) 2017-2021 LibreTime Community

Please refer to the LEGACY file for more information.