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

View file

@ -1,15 +1,14 @@
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const vars = require("./vars");
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Libretime",
tagline: "Broadcast without limits",
url: "https://libretime.org",
baseUrl: "/",
title: vars.title,
tagline: vars.description,
url: vars.website,
baseUrl: "/libretime/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
favicon: "img/icon.svg",
@ -19,7 +18,7 @@ const config = {
plugins: [
[
require.resolve("@cmfcmf/docusaurus-search-local"),
"@cmfcmf/docusaurus-search-local",
{
indexBlog: false,
indexPages: false,
@ -40,7 +39,7 @@ const config = {
docs: {
path: "../docs",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: "https://github.com/libretime/libretime",
editUrl: `${vars.repository.href}/blob/main/docs`,
},
blog: false,
theme: {
@ -54,25 +53,25 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: "Libretime",
title: vars.title,
logo: {
alt: "Libretime tower",
alt: "LibreTime tower",
src: "img/icon.svg",
},
items: [
{
type: "doc",
docId: "intro",
position: "left",
label: "Docs",
to: "/docs",
position: "left",
type: "dropdown",
items: vars.doc.sections,
},
{ to: "/contribute", label: "Contribute", position: "left" },
{ type: "localeDropdown", position: "right" },
{
href: "https://github.com/libretime/libretime",
label: "GitHub",
position: "right",
},
{ label: "Contribute", to: "/contribute", position: "left" },
{ ...vars.repository, position: "right" },
{ ...vars.forum, position: "right" },
{ ...vars.channel, position: "right" },
// { type: "localeDropdown", position: "right" },
],
},
footer: {
@ -80,41 +79,20 @@ const config = {
links: [
{
title: "Docs",
items: [
{
label: "Install",
to: "/docs/intro",
},
],
items: vars.doc.sections,
},
{
title: "Community",
items: [
{
label: "Discourse",
href: "https://discourse.libretime.org",
},
{
label: "Mattermost",
href: "https://chat.libretime.org",
},
],
items: [vars.forum, vars.channel],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/libretime/libretime",
},
],
items: [vars.repository],
},
],
copyright: `Code licensed under AGPLv3; docs licensed under GPLv2.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["apacheconf", "ini"],
},
}),