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

99
docs/user_documentation/channels/create_channel.md Normal file
View file

@ -0,0 +1,99 @@
# Create a channel
```{warning}
Your channel's __Fediverse handle__ needs to be unique. This is how other {term}`Fediverse` software identifies your channel. You can't change the __Fediverse handle__ once you've created your channel.
```
Create a channel to start publishing your content on your {term}`Funkwhale pod <Pod>`. Users can access channel content from Funkwhale or other Fediverse software.
You can create two types of channel:
```{contents}
:local:
```
## Artist discography
To create an __Artist discography__ channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Artist discography` and select {guilabel}`Next step`. The {guilabel}`Artist channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
11. Select {guilabel}`Create channel` to create your channel.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Artist discography` and select {guilabel}`Next step`. The {guilabel}`Artist channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
11. Select {guilabel}`Create channel` to create your channel.
```
That's it! You've created your artist channel. You can now [add some music to it](upload_artist.md).
## Podcast
To create a __Podcast__ channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Podcasts` and select {guilabel}`Next step`. The {guilabel}`Podcast channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. Choose the {guilabel}`Language` of your podcast.
11. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
12. Select the {guilabel}`Category` of your podcast. {term}`Podcatchers<Podcatcher>` use this information to sort your podcast content.
13. __Optional__ – select the {guilabel}`Subcategory` of your podcast.
14. __Optional__ – enter the {guilabel}`Owner e-mail address`. This populates the ``itunes:email`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
15. __Optional__ – enter the {guilabel}`Owner name`. This populates the ``itunes:name`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
16. Select {guilabel}`Create channel` to create your channel.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Podcasts` and select {guilabel}`Next step`. The {guilabel}`Podcast channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. Choose the {guilabel}`Language` of your podcast.
11. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
12. Select the {guilabel}`Category` of your podcast. {term}`Podcatchers<Podcatcher>` use this information to sort your podcast content.
13. __Optional__ – select the {guilabel}`Subcategory` of your podcast.
14. __Optional__ – enter the {guilabel}`Owner e-mail address`. This populates the ``itunes:email`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
15. __Optional__ – enter the {guilabel}`Owner name`. This populates the ``itunes:name`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
16. Select {guilabel}`Create channel` to create your channel.
```
You're done! You've created your podcast channel. Now you can [add some episodes to it](upload_podcast.md).

81
docs/user_documentation/channels/delete_artist.md Normal file
View file

@ -0,0 +1,81 @@
# Delete content from an Artist channel
You can delete content from your artist channel. This means that your followers won't be able to listen to the deleted content any more.
```{contents}
:local:
```
## Delete a track
```{warning}
Deleting a track also deletes the file from your {term}`Funkwhale pod <Pod>`. This action is irreversible.
```
To delete a single track from a channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the track in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Track details`. The track details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the track.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the track in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Track details`. The track details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the track.
```
That's it! You've deleted your track. You can add it again by [uploading it to your channel](upload_artist.md).
## Delete an album
```{warning}
Deleting an album also deletes all tracks in the album and removes the files from the server. This action is irreversible.
```
Delete an album to remove all tracks it contains. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your album in the {guilabel}`Albums` section. The album detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the album.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your album in the {guilabel}`Albums` section. The album detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the album.
```
You're done! You've deleted the album and all the tracks it contained. You can add them again by [uploading it to your channel](upload_artist.md).

33
docs/user_documentation/channels/delete_channel.md Normal file
View file

@ -0,0 +1,33 @@
# Delete a channel
```{warning}
Deleting a channel is irreversible. If you delete a channel you also delete the content associated with it. Users won't be able to access the channel any more. You can't re-use the channel's __Fediverse handle__ for another channel.
```
If you want to delete your channel, follow these steps:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Delete…`. A {guilabel}`Delete this Channel?` warning message appears
7. Select {guilabel}`Delete`.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Delete…`. A {guilabel}`Delete this Channel?` warning message appears
7. Select {guilabel}`Delete`.
```
That's it! You deleted your channel.

81
docs/user_documentation/channels/delete_podcast.md Normal file
View file

@ -0,0 +1,81 @@
# Delete content from a Podcast channel
You can delete content from your podcast channel. This means that your followers won't be able to listen to the deleted content any more.
```{contents}
:local:
```
## Delete an episode
```{warning}
Deleting an episode also deletes the file from the {term}`pod`. This action is irreversible.
```
To delete a single episode from a channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the episode in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Episode details`. The episode details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the episode.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the episode in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Episode details`. The episode details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the episode.
```
That's it! You've deleted your episode. You can add it again by [uploading it to your channel](upload_podcast.md).
## Delete a series
```{warning}
Deleting a series also deletes all episodes in the series and deletes the files from the {term}`pod`. This action is irreversible.
```
Delete a series to remove all episodes it contains. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your series in the {guilabel}`Series` section. The series detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the series.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your series in the {guilabel}`Series` section. The series detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the series.
```
You're done! You've deleted the series and all the episodes it contained. You can add them again by [uploading it to your channel](upload_podcast.md).

103
docs/user_documentation/channels/edit_channel.md Normal file
View file

@ -0,0 +1,103 @@
# Edit a channel
```{note}
You can't change a channel's __Fediverse handle__.
```
Channels are like user profiles on other {term}`Fediverse` software. This means you can edit their details at any time to reflect changes you've made.
You can change different details depending on what type of channel you are editing:
```{contents}
:local:
```
## Edit an Artist channel
To edit an __Artist channel__:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Description`
8. Select {guilabel}`Update channel` to save your changes.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Description`
8. Select {guilabel}`Update channel` to save your changes.
```
That's it! You've updated your channel details. Users see the new details when they visit your channel page.
## Edit a Podcast channel
To edit a __Podcast channel__:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Language`
- {guilabel}`Description`
- {guilabel}`Category`
- {guilabel}`Subcategory`
- {guilabel}`Owner e-mail address`
- {guilabel}`Owner name`
8. Select {guilabel}`Update channel` to save your changes.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Language`
- {guilabel}`Description`
- {guilabel}`Category`
- {guilabel}`Subcategory`
- {guilabel}`Owner e-mail address`
- {guilabel}`Owner name`
8. Select {guilabel}`Update channel` to save your changes.
```
You're done! Users see the new details when they visit your channel page. The changes also reflect on your podcast's {abbr}`RSS (Really Simple Syndication)` feed.

58
docs/user_documentation/channels/follow_channel.md Normal file
View file

@ -0,0 +1,58 @@
# Follow a channel
Get access to a channel's content by following it. Following a channel makes its content visible to all users on your {term}`pod`.
You can follow channels in a few different ways:
```{contents}
:local:
````
## Follow a channel on your pod
If a user on your pod follows a channel or has published a channel, you can follow it from your pod. To do this:
1. Select the channel you want to follow. The channel details page opens.
2. Select the {guilabel}`Subscribe` button. The label changes to {guilabel}`Subscribed`.
That's it! You've subscribed to the channel. You can see the channel in the {guilabel}`Channels` page.
## Follow a remote channel
To follow a channel located on another pod, you need its __Federation handle__. A __Federation handle__ uses the following format: ``@{username}@{domain}``. Once you have the channel's __Federation handle__, you can follow it from the {guilabel}`Channels` page. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Channels` in the sidebar. The {guilabel}`Channels` page opens.
2. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
3. Select {guilabel}`Fediverse`.
4. Enter the channel's __Federation handle__ in the {guilabel}`Fediverse object` input.
5. Select {guilabel}`Subscribe`. The channel details page appears.
6. Select the {guilabel}`Subscribe}` button. The label changes to {guilabel}`Subscribed`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {guilabel}`Channels`. The {guilabel}`Channels` page opens.
3. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
4. Select {guilabel}`Fediverse`.
5. Enter the channel's __Federation handle__ in the {guilabel}`Fediverse object` input.
6. Select {guilabel}`Subscribe`. The channel details page appears.
7. Select the {guilabel}`Subscribe}` button. The label changes to {guilabel}`Subscribed`.
```
That's it! You can now see the channel's content on your pod. Other users of your pod can also see this channel.
## Follow a Funkwhale podcast with a podcatcher
You can follow podcasts published in channels using a standard podcatcher. To do this:
1. Select the channel you want to follow. The channel details page opens.
2. Select the feed button ({fa}`feed`). The {guilabel}`Subscribe to this channel` window appears.
3. Select {guilabel}`Copy` under the {guilabel}`Subscribe via RSS` to copy the channel's {abbr}`RSS (Really Simple Syndication)` feed URL.
4. Paste the URL in your podcatcher.
That's it! Your podcatcher fetches the podcast details from Funkwhale.

46
docs/user_documentation/channels/index.md Normal file
View file

@ -0,0 +1,46 @@
# Channels
Use channels to publish your own audio content on Funkwhale. Channels enable you to create and share your creations with the whole {term}`Fediverse`.
Funkwhale supports two types of channel:
- __Podcasts__ – broadcast your podcast over the Fediverse. Listeners can also use their favorite {term}`podcatcher` to listen to podcasts using {abbr}`RSS (Really Simple Syndication)`.
- __Artist Discography__ – upload your own music and create a following.
Follow the guides in this section to get started.
```{toctree}
---
caption: Manage your channels
maxdepth: 1
---
create_channel
edit_channel
delete_channel
```
```{toctree}
---
caption: Manage channel content
maxdepth: 1
---
upload_artist
upload_podcast
delete_artist
delete_podcast
```
```{toctree}
---
caption: Follow channels
maxdepth: 1
---
follow_channel
subscribe_rss
```

30
docs/user_documentation/channels/subscribe_rss.md Normal file
View file

@ -0,0 +1,30 @@
# Subscribe to an RSS feed
```{note}
Other users on your pod can't see podcasts you import using RSS. They need to subscribe to the feed themselves.
```
You can use Funkwhale as a {term}`podcatcher` to listen to your favorite podcasts. Funkwhale can read {abbr}`RSS (Really Simple Syndication)` feeds to import podcasts. To add an RSS feed to Funkwhale:
```{tabbed} Desktop
1. Select {guilabel}`Channels` in the sidebar. The {guilabel}`Channels` page opens.
2. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
3. Select {guilabel}`RSS`.
4. Enter the URL of the RSS feed in the {guilabel}`RSS feed location` input.
5. Select {guilabel}`Subscribe`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {guilabel}`Channels`. The {guilabel}`Channels` page opens.
3. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
4. Select {guilabel}`RSS`.
5. Enter the URL of the RSS feed in the {guilabel}`RSS feed location` input.
6. Select {guilabel}`Subscribe`.
```
That's it! Your favorite podcast is now available in the {guilabel}`Channels` page. Funkwhale updates the feed to make sure you always have the latest episodes.

147
docs/user_documentation/channels/upload_artist.md Normal file
View file

@ -0,0 +1,147 @@
# Upload content to an Artist channel
Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods <Pod>`.
You can also create albums to organize your channel content.
```{contents}
:local:
```
## Create an album (optional)
Albums are a good way of organizing your content. You can create as many albums as you want. To create a new album:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add an album to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Albums` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your album.
7. Select {guilabel}`Create` to create your new album. The album appears on the screen.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add an album to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Albums` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your album.
7. Select {guilabel}`Create` to create your new album. The album appears on the screen.
```
Once you've created your album, you can add some details to it. To do this:
1. Select the album. The album details screen opens.
2. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
3. Select {guilabel}`Edit`. The {guilabel}`Edit this album` screen opens.
4. Change the details in any of these fields:
- {guilabel}`Title` – the title of the album.
- {guilabel}`Description` – a description of the album.
- {guilabel}`Release date` – the release date of the album.
- {guilabel}`Cover` – the cover art of the album.
- {guilabel}`Tags` – the genre of the album.
5. __Optional__ – enter a {guilabel}`Summary` of your changes.
6. Select {guilabel}`Submit and apply edit` to save your changes.
That's it! You can now add content to your album.
## Add your content
To add content to your channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker, or drag and drop your files on to it.
- If you opened the file picker, select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker. Select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
### Edit your uploads
Once you have uploaded your files, you can change their details. To do this:
1. Select the edit icon ({fa}`edit`) to edit the track details. The {guilabel}`Upload details` screen appears.
2. Change the details in any of these fields:
- {guilabel}`Title` – the title of the track
- {guilabel}`Track Picture` – the picture that shows up next to the track.
- {guilabel}`Tags` – the genre of the track.
- {guilabel}`Position` – the position of the track in the album.
- {guilabel}`Description` – a description of the track.
3. Select {guilabel}`Update` to save the track details.
4. Do this for all tracks you want to publish.
5. Select {guilabel}`Publish` to publish the content. To save the content to [upload later](#continue-your-upload-later), select {menuselection}`Down arrow --> Finish later`.
That's it! You've added content to your channel. Your followers can now listen to your content from their pods.
## Continue your upload later
If you selected {guilabel}`Finish later`, Funkwhale saves your files and edits. You can continue your upload later by doing the following:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
Congratulations! You've finished uploading the saved content. Your followers can now listen to your content from their pods.

147
docs/user_documentation/channels/upload_podcast.md Normal file
View file

@ -0,0 +1,147 @@
# Upload content to an Podcast channel
Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods <Pod>`.
You can also create series to organize your channel content.
```{contents}
:local:
```
## Create a series (optional)
Series are a good way of organizing your content. You can create as many series as you want. To create a new series:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add a series to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Series` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your series.
7. Select {guilabel}`Create` to create your new series. The series appears on the screen.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add a series to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Series` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your series.
7. Select {guilabel}`Create` to create your new series. The series appears on the screen.
```
Once you've created your series, you can add some details to it. To do this:
1. Select the series. The series details screen opens.
2. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
3. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this album` screen opens.
4. Change the details in any of these fields:
- {guilabel}`Title` – the title of the series.
- {guilabel}`Description` – a description of the series.
- {guilabel}`Release date` – the date on which the series aired.
- {guilabel}`Cover` – a cover image for the series.
- {guilabel}`Tags` – tags relating to the series' content.
5. __Optional__ – enter a {guilabel}`Summary` of your changes.
6. Select {guilabel}`Submit and apply edit` to save your changes.
That's it! Your series is ready to use.
## Add your content
To add content to your channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker, or drag and drop your files on to it.
- If you opened the file picker, select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker. Select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
### Edit your uploads
Once you have uploaded your files, you can change their details. To do this:
1. Select the edit icon ({fa}`edit`) to edit the track details. The {guilabel}`Upload details` screen appears.
2. Change the details in any of these fields:
- {guilabel}`Title` – the title of the episode
- {guilabel}`Track Picture` – the picture that shows up next to the episode.
- {guilabel}`Tags` – tags relating to the episode content.
- {guilabel}`Position` – the position of the track in the series.
- {guilabel}`Description` – a description of the track.
3. Select {guilabel}`Update` to save the track details.
4. Do this for all episodes you want to publish.
5. Select {guilabel}`Publish` to publish the content. To save the content to upload later, select {menuselection}`Down arrow --> Finish later`.
That's it! You've added content to your channel. Your followers can now listen to your content from their pods or podcatchers.
## Continue your upload later
If you selected {guilabel}`Finish later`, Funkwhale saves your files and edits. You can continue your upload later by doing the following:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
Congratulations! You've finished uploading the saved content. Your followers can now listen to your content from their pods.