diff --git a/_meta/README.md b/_meta/README.md new file mode 100644 index 0000000..afef6e5 --- /dev/null +++ b/_meta/README.md @@ -0,0 +1,16 @@ +# Official Indico Plugins + +This package is a meta-package that installs the most common Indico plugins +that are developed by the core Indico development team. + +It does not have any functionality by itself; its sole purpose is to provide +a single package that can be installed and updated easily. + +## Changelog + +The major/minor version of this package should match the Indico version you +are using. So if you have Indico 3.0.x, then you should install version 3.0.x +of the `indico-plugins` package. + +Note that we only make new releases of the plugin package as needed, so It would +be perfectly fine to have Indico 3.0.2 while still on `indico-plugins` 3.0. diff --git a/_meta/setup.cfg b/_meta/setup.cfg index c7b6395..4431dac 100644 --- a/_meta/setup.cfg +++ b/_meta/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugins version = 3.0rc1 description = A meta-package containing the official Indico plugins +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/citadel/README.md b/citadel/README.md new file mode 100644 index 0000000..1f0552b --- /dev/null +++ b/citadel/README.md @@ -0,0 +1,13 @@ +# Citadel Search Plugin + +The Citadel plugin integrates Indico with the [Citadel][citadel] microservice +to provide advanced search functionality using an Elasticsearch backend. + +## Changelog + +### 3.0 + +- Initial release + + +[citadel]: https://gitlab.cern.ch/webservices/cern-search/cern-search-rest-api diff --git a/citadel/setup.cfg b/citadel/setup.cfg index 8ca25ee..1c18f81 100644 --- a/citadel/setup.cfg +++ b/citadel/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-citadel version = 3.0rc1 description = Indico search+livesync backend using Citadel+ElasticSearch +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/livesync/README.md b/livesync/README.md new file mode 100644 index 0000000..3f41c81 --- /dev/null +++ b/livesync/README.md @@ -0,0 +1,12 @@ +# LiveSync Plugin + +The LiveSync plugin provides a framework for exporting Indico event data to +external services, typically to provide advanced search functionality. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 +- Major changes to improve efficiency and correctness of the data sent both + during an initial data export and during queue runs diff --git a/livesync/setup.cfg b/livesync/setup.cfg index c31396d..496609c 100644 --- a/livesync/setup.cfg +++ b/livesync/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-livesync version = 3.0rc1 description = Framework for pushing Indico event data to external services +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/livesync_debug/README.md b/livesync_debug/README.md new file mode 100644 index 0000000..48f6d39 --- /dev/null +++ b/livesync_debug/README.md @@ -0,0 +1,13 @@ +# LiveSync Debug Plugin + +The LiveSync debug plugin is meant for developers who want to see the +queue entries and how they are simplified into actual CRUD-like updates. + +It's only intended for developers and thus it is not included when installing +plugins via the `indico-plugins` meta package. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/livesync_debug/setup.cfg b/livesync_debug/setup.cfg index ad5d247..c15c9ee 100644 --- a/livesync_debug/setup.cfg +++ b/livesync_debug/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-livesync-debug version = 3.0rc1 description = Debug target for the Indico LiveSync plugin +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/payment_manual/README.md b/payment_manual/README.md new file mode 100644 index 0000000..372763a --- /dev/null +++ b/payment_manual/README.md @@ -0,0 +1,13 @@ +# Manual Payment Plugin + +This plugin provides a "manual" payment option for Indico's payment module which +is typically used for payments via Bank Transfer. It allows event organizers to +define a custom text with various placeholders to provide information on how to +make a payment or even link to an external payment service that has no deeper +integration with Indico. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/payment_manual/setup.cfg b/payment_manual/setup.cfg index 705d6f1..4666012 100644 --- a/payment_manual/setup.cfg +++ b/payment_manual/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-payment-manual version = 3.0rc1 description = Payment plugin for Indico that can be used for custom payment information/links +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/payment_paypal/README.md b/payment_paypal/README.md new file mode 100644 index 0000000..401cc5c --- /dev/null +++ b/payment_paypal/README.md @@ -0,0 +1,15 @@ +# PayPal Payment Plugin + +This plugin provides a PayPal payment option for Indico's payment module. + +When used, the user will be sent to PayPal to make the payment, and afterwards +they are automatically sent back to Indico. It relies on PayPal's IPN payment +notification for Indico to automatically mark the registrant as paid once the +payment has been made and processed by PayPal. + + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/payment_paypal/setup.cfg b/payment_paypal/setup.cfg index a8b5776..35c1b17 100644 --- a/payment_paypal/setup.cfg +++ b/payment_paypal/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-payment-paypal version = 3.0rc1 description = PayPal payments for Indico event registration fees +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/piwik/README.md b/piwik/README.md new file mode 100644 index 0000000..1863253 --- /dev/null +++ b/piwik/README.md @@ -0,0 +1,13 @@ +# Piwik Plugin + +The Piwik plugin allows integrating Indico with a Piwik instance to gather +statistics about the users accessing Indico or specific Indico events. + +Please note that the plugin has not been tested with Piwik's successor, +Matomo, so we do not know whether it is compatible with it or not. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/piwik/setup.cfg b/piwik/setup.cfg index 1bec436..dcebc3a 100644 --- a/piwik/setup.cfg +++ b/piwik/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-piwik version = 3.0rc1 description = Piwik integration for global and event-specific statistics in Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/previewer_code/README.md b/previewer_code/README.md new file mode 100644 index 0000000..f0fde87 --- /dev/null +++ b/previewer_code/README.md @@ -0,0 +1,22 @@ +# Code Preview Plugin + +This plugin adds syntax highlighting (using the Pygments syntax highlighter) +to event materials that look like source code files. + +The following languages are supported: + +- C / C++ +- C# +- CSS +- Fortran +- Java +- JavaScript +- PHP +- Python +- Ruby + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/previewer_code/setup.cfg b/previewer_code/setup.cfg index 5c4a141..3d81da5 100644 --- a/previewer_code/setup.cfg +++ b/previewer_code/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-previewer-code version = 3.0rc1 description = Syntax highlighter for code attachments in Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/previewer_jupyter/README.md b/previewer_jupyter/README.md new file mode 100644 index 0000000..ffec4aa --- /dev/null +++ b/previewer_jupyter/README.md @@ -0,0 +1,10 @@ +# Jupyter Preview Plugin + +This plugin renders Jupyter notebooks nicely as HTML when they are attached as +material to an Indico event. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/previewer_jupyter/setup.cfg b/previewer_jupyter/setup.cfg index 97801a6..102e04b 100644 --- a/previewer_jupyter/setup.cfg +++ b/previewer_jupyter/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-previewer-jupyter version = 3.0rc1 description = Jupyter notebook rendering for attachments in Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/storage_s3/README.md b/storage_s3/README.md index 60867e1..ac230fc 100644 --- a/storage_s3/README.md +++ b/storage_s3/README.md @@ -13,13 +13,19 @@ It is currently used in production on multiple Indico instances, so we believe i stable, but please be advised that we do not provide a way to move files back from S3 to local storage (but it would of course be possible to write a script for this). +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 + ## Configuration Configuration is done using the `STORAGE_BACKENDS` entry of `indico.conf`; add a new key with a name of your choice (e.g. `s3`) and specify the details of the S3 storage in the value. -For a single bucket, all you need to specify is the bucket name: +For a single bucket, all you need to specify is the bucket name: ```python STORAGE_BACKENDS = { diff --git a/themes_legacy/README.md b/themes_legacy/README.md new file mode 100644 index 0000000..7af4187 --- /dev/null +++ b/themes_legacy/README.md @@ -0,0 +1,20 @@ +# Legacy Themes plugin + +This plugin contains the "Compact style" (`nicecompact`) theme for Indico events: + +![Compact style](https://raw.githubusercontent.com/indico/indico-plugins/master/themes_legacy/theme-nicecompact.png) + +We consider the look and feel of this theme very outdated and no longer up to +our standards, but as some users may still want to use this theme, we provide +this plugin in order to keep it alive. + +This plugin needs to be installed explicitly; it is not part of the `indico-plugins` +meta package as we do not recommend anyone setting up Indico to make this theme +available - its sole purpose is to not force existing users of the theme to stop +using it when an instance is upgraded to 3.0. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/themes_legacy/setup.cfg b/themes_legacy/setup.cfg index dfbf927..629a850 100644 --- a/themes_legacy/setup.cfg +++ b/themes_legacy/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-themes-legacy version = 3.0rc1 description = Legacy themes for Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/themes_legacy/theme-nicecompact.png b/themes_legacy/theme-nicecompact.png new file mode 100644 index 0000000..9f090be Binary files /dev/null and b/themes_legacy/theme-nicecompact.png differ diff --git a/ursh/README.md b/ursh/README.md new file mode 100644 index 0000000..000bac0 --- /dev/null +++ b/ursh/README.md @@ -0,0 +1,21 @@ +# URL Shortener Plugin (ursh) + +This plugin adds the ability to create shortcut URLs using the external +[ursh][ursh] URL shortening microservice to Indico. + +Please note that you need to deploy your own instance of ursh in order to +use this plugin. + +Ideally you also have a very short domain name for the short URLs; if you do +not own such a domain, it is not recommended to use this plugin but rather use +the builtin shortcut URL feature of Indico which lets event organizers define +human-friendly shortcuts pointing to an event (such as `https://indico.example.com/e/cool-event`). + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 + + +[ursh]: https://github.com/indico/ursh diff --git a/ursh/setup.cfg b/ursh/setup.cfg index 7a54748..3092678 100644 --- a/ursh/setup.cfg +++ b/ursh/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-ursh version = 3.0rc1 description = URL shortening service for Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/vc_dummy/README.md b/vc_dummy/README.md new file mode 100644 index 0000000..de12521 --- /dev/null +++ b/vc_dummy/README.md @@ -0,0 +1,14 @@ +# Dummy Videoconference Plugin + +The dummy videoconference plugin is meant for developers who want to test the +videoconference management functionality in Indico without having access to an +actual videoconference service supported by Indico. + +It's only intended for developers and thus it is not included when installing +plugins via the `indico-plugins` meta package. + +## Changelog + +### 3.0 + +- Initial release for Indico 3.0 diff --git a/vc_dummy/setup.cfg b/vc_dummy/setup.cfg index 7eef29e..f93de37 100644 --- a/vc_dummy/setup.cfg +++ b/vc_dummy/setup.cfg @@ -2,6 +2,8 @@ name = indico-plugin-vc-dummy version = 3.0rc1 description = Dummy/example video-conferencing plugin for Indico +long_description = file: README.md +long_description_content_type = text/markdown; charset=UTF-8; variant=GFM url = https://github.com/indico/indico-plugins license = MIT author = Indico Team diff --git a/vc_zoom/README.md b/vc_zoom/README.md index ccbcdac..833ffcc 100644 --- a/vc_zoom/README.md +++ b/vc_zoom/README.md @@ -1,4 +1,4 @@ -# Indico Plugin for Zoom +# Zoom Videoconference Plugin ## Features