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:
Jonas L 2022-02-21 08:16:54 +01:00 committed by GitHub
parent 5769821995
commit 3ec85d7821
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
107 changed files with 682 additions and 512 deletions

36
website/vars.js Normal file
View file

@ -0,0 +1,36 @@
module.exports = {
title: "LibreTime",
description: "Radio Broadcast & Automation Platform",
version: "3.0.0-alpha.10",
website: "https://jooola.github.io",
repository: {
href: "https://github.com/libretime/libretime",
label: "Github",
},
forum: {
href: "https://discourse.libretime.org",
label: "Discourse",
},
channel: {
href: "https://chat.libretime.org",
label: "Mattermost",
},
home: {
links: [
{ label: "Get started 🚀", to: "/docs/admin-manual" },
{ label: "Release note", to: "/docs/releases/3.0.0-alpha.10" },
],
},
doc: {
sections: [
{ label: "Admin manual", to: "/docs/admin-manual" },
{ label: "User manual", to: "/docs/user-manual" },
{ label: "Developer manual", to: "/docs/developer-manual" },
],
},
};