From b76f8320682dc611c556095e26f8f112de730c35 Mon Sep 17 00:00:00 2001 From: janis Date: Mon, 18 Sep 2023 17:11:00 +0200 Subject: [PATCH] more docs --- .../dist/docs/admin-panel/events/index.html | 6 ----- .../dist/docs/admin-panel/pages/index.html | 2 +- .../dist/docs/admin-panel/plugins/index.html | 4 +++- website/dist/docs/contributing/index.html | 24 ++++++++++++++++++- .../dist/docs/plugins/installation/index.html | 7 ++++++ website/src/admin-panel/events.md | 11 +-------- website/src/admin-panel/pages.md | 2 +- website/src/admin-panel/plugins.md | 6 ++++- website/src/contributing.md | 24 ++++++++++++++++++- website/src/plugins/installation.md | 10 ++++++++ 10 files changed, 74 insertions(+), 22 deletions(-) diff --git a/website/dist/docs/admin-panel/events/index.html b/website/dist/docs/admin-panel/events/index.html index b94e0a7..b454f4b 100644 --- a/website/dist/docs/admin-panel/events/index.html +++ b/website/dist/docs/admin-panel/events/index.html @@ -27,12 +27,6 @@

Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway.

Event location

Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide here

-

Guest purchase

-

Choose if a user may purchase a ticket without creating an account. An email address is always required as the system sends the tickets via email to the customers for easier access.

-

Allow overbooking

-

Activate this and set a percentage of overbooking, if you want to enable overbooking of the event to ensure that every single spot is occupied even if somebody does not show up. Use is strongly discouraged and currently only works with events that have no seating plan.

-

Special requirements

-

Here you may set a special requirement that a person booking a ticket has to fulfill, like the email address has to be ending in @yourdomain.com or they need to live in a certain street / town / city / country in order for them to be allowed to buy a ticket. You may also require that they provide a certain number, code or similar. Finally, you may choose to limit the amount of tickets a single person may reserve.

diff --git a/website/dist/docs/admin-panel/pages/index.html b/website/dist/docs/admin-panel/pages/index.html index 8128b2e..d4c1fec 100644 --- a/website/dist/docs/admin-panel/pages/index.html +++ b/website/dist/docs/admin-panel/pages/index.html @@ -18,7 +18,7 @@

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.

+

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. 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, you can create a custom HTML start page. If you need even more customization, 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.

diff --git a/website/dist/docs/admin-panel/plugins/index.html b/website/dist/docs/admin-panel/plugins/index.html index 9afe67c..f1e2ba0 100644 --- a/website/dist/docs/admin-panel/plugins/index.html +++ b/website/dist/docs/admin-panel/plugins/index.html @@ -18,7 +18,9 @@

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.

+

libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. 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.

+

Please only install plugins from sources you trust!

+

You may read on about plugins here and you can find an installation guide here.

diff --git a/website/dist/docs/contributing/index.html b/website/dist/docs/contributing/index.html index 028ef0c..1875aa7 100644 --- a/website/dist/docs/contributing/index.html +++ b/website/dist/docs/contributing/index.html @@ -18,7 +18,29 @@

Getting Started

-

You are interested in helping develop this project to make it even better? Then let's show you, how you may help and what you should keep in mind!

+

You are interested in helping develop this project to make it even better? Then let us show you, how you may help and what you should keep in mind!

+

Things to contribute to

+

You may contribute to any of the following things (list is not exhaustive):

+
    +
  • Writing new payment gateway integrations
    • +
  • Writing any kind of new plugins
    • +
  • Help integrating (or integrate) a translation api
    • +
  • Fix any kinds of bugs
    • +
  • Improve security
    • +
  • Improve speed
    • +
  • Add more documentation
    • +
  • Improve design
    • +
  • Add guest purchases
    • +
  • Make seat plan editor even more versatile
    • +
  • General refactoring, code quality improvements
    • +
  • Marketing
    • +
  • Update project website
    • +
  • Add permission settings and permissions to admin panel
    • +
  • Improve iOS and Android App functionality
    • +
  • Add an admin account page
    • +
+

Before starting to contribute

+

Before you start coding, please make yourself familiar with the code of conduct and the linter settings. Another thing that is not required, but certainly a good idea is to open an issue on our GitHub to have a discussion about the changes you want to make so that you don't waste your time, if the thing you want to do is not something we feel like is necessary.

diff --git a/website/dist/docs/plugins/installation/index.html b/website/dist/docs/plugins/installation/index.html index bc65460..cba0345 100644 --- a/website/dist/docs/plugins/installation/index.html +++ b/website/dist/docs/plugins/installation/index.html @@ -18,6 +18,13 @@

Plugin installation

+

Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners

+

Acquiring the plugins

+

You can find a list of plugins that libreevent supports here. Choose one and click it to be directed to the download page.

+

Installing payment gateway plugins

+

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/payments and uploading the plugin folder into there. Now, restart libreevent.

+

Installing other plugins

+

You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to /backend/plugins/others and uploading the plugin folder into there. Now, restart libreevent.

diff --git a/website/src/admin-panel/events.md b/website/src/admin-panel/events.md index f6e84b0..6b4c5f8 100644 --- a/website/src/admin-panel/events.md +++ b/website/src/admin-panel/events.md @@ -11,13 +11,4 @@ This is the name that is being displayed when users are browsing your events. Ca Describe what your event is about. It will be displayed underneath the event name when users are browsing your events. In the browsing view, the length of the description is limited to 150 characters, after which three dots will be added to the text and a 'continue reading' button will be added. Technically, there's no limit to the length of the event description, but don't overdo it with the length, as the user is unlikely to read more than a couple words anyway. ### Event location -Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide [here](&/admin-panel/seatplan-editor) - -## Guest purchase -Choose if a user may purchase a ticket without creating an account. An email address is always required as the system sends the tickets via email to the customers for easier access. - -## Allow overbooking -Activate this and set a percentage of overbooking, if you want to enable overbooking of the event to ensure that every single spot is occupied even if somebody does not show up. Use is strongly discouraged and currently only works with events that have no seating plan. - -## Special requirements -Here you may set a special requirement that a person booking a ticket has to fulfill, like the email address has to be ending in @yourdomain.com or they need to live in a certain street / town / city / country in order for them to be allowed to buy a ticket. You may also require that they provide a certain number, code or similar. Finally, you may choose to limit the amount of tickets a single person may reserve. \ No newline at end of file +Choose a location where your event is going to take place. You can do so by selecting an existing location from the dropdown or by adding a new one. In the same step, you'll also need to choose between a seat plan and no seat plan, and if you choose a seat plan, you'll need to create one using out handy seatplan editor. See our seatplan editor guide [here](&/admin-panel/seatplan-editor) \ No newline at end of file diff --git a/website/src/admin-panel/pages.md b/website/src/admin-panel/pages.md index d61e8b1..d4af224 100644 --- a/website/src/admin-panel/pages.md +++ b/website/src/admin-panel/pages.md @@ -1,3 +1,3 @@ # 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 +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](/templates). 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, you can create a custom HTML start page. If you need even more customization, 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 61e2902..611c514 100644 --- a/website/src/admin-panel/plugins.md +++ b/website/src/admin-panel/plugins.md @@ -1,3 +1,7 @@ # 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 +libreevent can be extended easily with plugins. Plugins add additional features and can be official or community made. 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. + +**Please only install plugins from sources you trust!** + +You may read on about plugins [here](&/plugins/) and you can find an installation guide [here](&/plugins/installation). \ No newline at end of file diff --git a/website/src/contributing.md b/website/src/contributing.md index 5e41730..608f849 100644 --- a/website/src/contributing.md +++ b/website/src/contributing.md @@ -1,2 +1,24 @@ # Getting Started -You are interested in helping develop this project to make it even better? Then let's show you, how you may help and what you should keep in mind! \ No newline at end of file +You are interested in helping develop this project to make it even better? Then let us show you, how you may help and what you should keep in mind! + +## Things to contribute to +You may contribute to any of the following things (list is not exhaustive): +- Writing new payment gateway integrations +- Writing any kind of new plugins +- Help integrating (or integrate) a translation api +- Fix any kinds of bugs +- Improve security +- Improve speed +- Add more documentation +- Improve design +- Add guest purchases +- Make seat plan editor even more versatile +- General refactoring, code quality improvements +- Marketing +- Update project website +- Add permission settings and permissions to admin panel +- Improve iOS and Android App functionality +- Add an admin account page + +## Before starting to contribute +Before you start coding, please make yourself familiar with the code of conduct and the linter settings. Another thing that is not required, but certainly a good idea is to open an issue on our GitHub to have a discussion about the changes you want to make so that you don't waste your time, if the thing you want to do is not something we feel like is necessary. \ No newline at end of file diff --git a/website/src/plugins/installation.md b/website/src/plugins/installation.md index bb6c0ad..09d5cdc 100644 --- a/website/src/plugins/installation.md +++ b/website/src/plugins/installation.md @@ -1,2 +1,12 @@ # Plugin installation +**Installing plugins currently isn't easy. We expect you to know how to upload files to a server. If you don't know, a guide on how to upload things can be found in the setup guide which is meant for beginners** + +## Acquiring the plugins +You can find a list of plugins that libreevent supports [here](/plugins). Choose one and click it to be directed to the download page. + +## Installing payment gateway plugins +You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/payments* and uploading the plugin folder into there. Now, restart libreevent. + +## Installing other plugins +You can install a new plugin by navigating to the libreevent directory on the server and then by navigating to */backend/plugins/others* and uploading the plugin folder into there. Now, restart libreevent. \ No newline at end of file