From 6083ec262c1b14be61b6e2245dd10b05c6a607c7 Mon Sep 17 00:00:00 2001 From: Janis Hutz Date: Sat, 29 Jul 2023 11:08:32 +0200 Subject: [PATCH] add more documentation --- website/src/admin-panel/pages.md | 4 +++- website/src/admin-panel/plugins.md | 4 +++- website/src/contributing/code-of-conduct.md | 1 + website/src/contributing/design-guidelines.md | 2 ++ website/src/contributing/plugins.md | 11 ++++++++++- 5 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 website/src/contributing/code-of-conduct.md create mode 100644 website/src/contributing/design-guidelines.md diff --git a/website/src/admin-panel/pages.md b/website/src/admin-panel/pages.md index 16db9d6..d61e8b1 100644 --- a/website/src/admin-panel/pages.md +++ b/website/src/admin-panel/pages.md @@ -1 +1,3 @@ -# Pages \ No newline at end of file +# Pages + +With the page editor you can easily create the start page (the landing page, so the page that gets displayed when the user visits the website). You may select one of a few templates which you can choose [here](TODO: ADD LINK). Then you should upload the promotional text and a few images. The image count depends on the template selected. If you want to use a more feature rich start page, please consider moving libreevent to a sub-domain and building a complete website on the main domain. You can get beautiful fully custom websites built for you [here](https://development.janishutz.com). \ No newline at end of file diff --git a/website/src/admin-panel/plugins.md b/website/src/admin-panel/plugins.md index f39a3a0..61e2902 100644 --- a/website/src/admin-panel/plugins.md +++ b/website/src/admin-panel/plugins.md @@ -1 +1,3 @@ -# Plugins \ No newline at end of file +# Plugins + +libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. You can see which plugins are official by their badge. When installing plugins, you need to remember that a server restart is required to activate the plugins as libreevent does not feature hot module loading (yet). You then can manage the plugins using their built-in settings page that they ship with. \ No newline at end of file diff --git a/website/src/contributing/code-of-conduct.md b/website/src/contributing/code-of-conduct.md new file mode 100644 index 0000000..8ed4d83 --- /dev/null +++ b/website/src/contributing/code-of-conduct.md @@ -0,0 +1 @@ +# Code of Conduct \ No newline at end of file diff --git a/website/src/contributing/design-guidelines.md b/website/src/contributing/design-guidelines.md new file mode 100644 index 0000000..a4dff35 --- /dev/null +++ b/website/src/contributing/design-guidelines.md @@ -0,0 +1,2 @@ +# Design Guidelines + diff --git a/website/src/contributing/plugins.md b/website/src/contributing/plugins.md index 533a8cd..53fc454 100644 --- a/website/src/contributing/plugins.md +++ b/website/src/contributing/plugins.md @@ -1 +1,10 @@ -# Contributing Plugins \ No newline at end of file +# Contributing Plugins + +If you wish to contribute plugins and have them accepted into the official repository then your plugin has to: +- fulfill the code layout requirements given by the linter config +- follow the libreevent [design guidelines](&/contributing/design-guidelines) +- conform to our [code of conduct](&/contributing/code-of-conduct) +- not contain any immediately obvious flaws (as layed out in the code of conduct), be it in terms of security or reliability +- provide all necessary files for libreevent +- offer settings if possible and necessary and a way to graphically edit them +- have extensive documentation on its usage. Once accepted into the official repos, the documentation will be added to the official documentation. \ No newline at end of file