novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Overhaul end user documentation

Browse source
This commit is contained in:
Ciarán Ainsworth 2022-01-19 18:49:46 +00:00
commit 1ec7e1e8e5
97 changed files with 3240 additions and 1553 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/user_documentation/plugins/index.md Normal file
View file

@ -0,0 +1,19 @@
# User plugins
```{note}
Your {term}`pod's <Pod>` admin needs to enable plugins for you to use them. If you can't find the plugins mentioned here, contact your pod admin.
```
Use plugins to extend Funkwhale's features. The Funkwhale collective maintains core plugins to make your listening experience even better. Developers can create extra plugins to add features to a pod.
```{toctree}
---
maxdepth: 1
caption: Core plugins
---
scrobbler_plugin
listenbrainz_plugin
maloja_plugin
```

33
docs/user_documentation/plugins/listenbrainz_plugin.md Normal file
View file

@ -0,0 +1,33 @@
# ListenBrainz plugin
The __ListenBrainz__ plugin enables you to submit ({term}`scrobble<Scrobbling>`) listens to your [ListenBrainz](https://listenbrainz.org) account. Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens. To set up the __ListenBrainz plugin__:
```{tabbed} Desktop
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`ListenBrainz` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter {guilabel}`Your ListenBrainz user token`. You can find this on your ListenBrainz profile.
9. Select {guilabel}`Save`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`ListenBrainz` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter {guilabel}`Your ListenBrainz user token`. You can find this on your ListenBrainz profile.
9. Select {guilabel}`Save`.
```
That's it! You've set up the __ListenBrainz__ plugin. When you listen to tracks, the plugin sends the information to ListenBrainz.

37
docs/user_documentation/plugins/maloja_plugin.md Normal file
View file

@ -0,0 +1,37 @@
# Maloja plugin
The __Maloja__ plugin enables you to submit ({term}`scrobble <Scrobbling>`) listens to your Maloja server. [Maloja](https://github.com/krateng/maloja) is a self-hosted scrobbling service similar to [Last.fm](https://last.fm) and [ListenBrainz](https://listenbrainz.org). Check out [their documentation](https://github.com/krateng/maloja#how-to-install) to set up your own server.
Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens. To set up the __Maloja plugin__:
```{tabbed} Desktop
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Maloja` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter your {guilabel}`Maloja server URL`. This is the URL you set up for your Maloja server.
9. Enter {guilabel}`Your Maloja API key`. Check out [Maloja's documentation](https://github.com/krateng/maloja#how-to-scrobble) for more information.
10. Select {guilabel}`Save`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Maloja` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter your {guilabel}`Maloja server URL`. This is the URL you set up for your Maloja server.
9. Enter {guilabel}`Your Maloja API key`. Check out [Maloja's documentation](https://github.com/krateng/maloja#how-to-scrobble) for more information.
10. Select {guilabel}`Save`.
```
That's it! You've set up the __Maloja__ plugin. When you listen to tracks, the plugin sends the information to your Maloja server.

47
docs/user_documentation/plugins/scrobbler_plugin.md Normal file
View file

@ -0,0 +1,47 @@
# Scrobbler plugin
```{note}
If you want to use [Last.fm](https://last.fm) to scrobble your listens, your pod admin needs to set up an API account. Contact your {term}`pod` admin if you have any questions.
```
The __Scrobbler__ plugin enables you to submit ({term}`scrobble<Scrobbling>`) listens to a scrobbler service. Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens.
```{tip}
Using ListenBrainz or Maloja? Check out the [ListenBrainz](listenbrainz_plugin) and [Maloja](maloja_plugin) plugins!
```
The __Scrobbler__ plugin supports any scrobbling service that uses the Audioscrobbler protocol. To set up the __Scrobbler plugin__:
```{tabbed} Desktop
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Scrobbler` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter the {guilabel}`URL of the scrobbler service`. If you leave this field blank, the plugin defaults to __Last.fm__.
9. Enter {guilabel}`Your scrobbler username`. You can set this up on your scrobbler service.
10. Enter {guilabel}`Your scrobbler password`. You can set this up on your scrobbler service.
11. Select {guilabel}`Save`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Scrobbler` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter the {guilabel}`URL of the scrobbler service`. If you leave this field blank, the plugin defaults to __Last.fm__.
9. Enter {guilabel}`Your scrobbler username`. You can set this up on your scrobbler service.
10. Enter {guilabel}`Your scrobbler password`. You can set this up on your scrobbler service.
11. Select {guilabel}`Save`.
```
That's it! You've set up the __Scrobbler__ plugin. When you listen to tracks, the plugin sends the information to your scrobbler service.