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
This commit is contained in:
parent
5769821995
commit
3ec85d7821
107 changed files with 682 additions and 512 deletions
29
docs/README.md
Normal file
29
docs/README.md
Normal file
|
@ -0,0 +1,29 @@
|
|||
---
|
||||
title: Welcome
|
||||
sidebar_position: 10
|
||||
---
|
||||
|
||||
Welcome to the **LibreTime documentation**, you should find everything you need to know about LibreTime.
|
||||
|
||||
:::caution
|
||||
|
||||
:construction: LibreTime is in being modernized and is finalizing the forking process. Be aware that breaking change may occur and that the documentation may not be up to date.
|
||||
|
||||
:::
|
||||
|
||||
## Getting started
|
||||
|
||||
**Are you new to LibreTime? This is the place to start!**
|
||||
|
||||
The documentation is divided into multiple parts:
|
||||
|
||||
- the [Administrator manual](./admin-manual) provide guides and references to setup and configure LibreTime.
|
||||
- the [User manual](./user-manual) provide guides and tutorials for managers, and content creators to use LibreTime.
|
||||
- the [Developer manual](./developer-manual) provide guides to integrate LibreTime, or improve and contribute to LibreTime.
|
||||
|
||||
## Getting help
|
||||
|
||||
Having trouble? We’d like to help!
|
||||
|
||||
- [:question: Try the Forum – it’s got answers to many common questions](https://discourse.libretime.org/).
|
||||
- [:bug: Report bugs with LibreTime in our ticket tracker.](https://github.com/libretime/libretime/issues)
|
Loading…
Add table
Add a link
Reference in a new issue